RHIDP-14672: Develop category JTBD content

assemblies/configure_customizing-rhdh/assembly-about-software-templates.adoc

@@ -11,8 +11,8 @@ ifdef::context[:parent-context: {context}]
 Software Templates in {product} provide a streamlined way to create software components and publish them to different version control repositories such as Git.
 Platform engineers create and maintain Software Templates in {product}.
 
-include::../modules/shared/proc-version-a-software-template-in-rhdh.adoc[leveloffset=+1]
-include::../modules/shared/proc-enable-software-template-version-update-notifications-in-rhdh.adoc[leveloffset=+1]
+include::../modules/shared/proc-version-software-templates.adoc[leveloffset=+1]
+include::../modules/shared/proc-enable-update-notifications.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 [role="_additional-resources"]

assemblies/configure_customizing-rhdh/assembly-automated-software-template-lifecycle-management.adoc

@@ -14,8 +14,8 @@ When Software Templates receive security updates or configuration changes, you c
 
 Automated template lifecycle management maintains consistency by monitoring your source templates. When a template version changes, the `scaffolder-relation-processor` plugin identifies all entities provisioned from that template and creates a pull request (PR) or merge request (MR) containing the necessary file updates, additions, or deletions.
 
-include::../modules/shared/proc-enable-automated-template-updates.adoc[leveloffset=+1]
-include::../modules/shared/ref-template-sync-considerations-and-limitations.adoc[leveloffset=+1]
+include::../modules/shared/proc-enable-the-scaffolder-relation-processor.adoc[leveloffset=+1]
+include::../modules/shared/ref-template-sync-limitations.adoc[leveloffset=+1]
 include::../modules/shared/ref-template-synchronization-and-notification-outcomes.adoc[leveloffset=+1]
 
 :context: {previouscontext}

assemblies/configure_customizing-rhdh/assembly-standardize-project-development-with-software-templates.adoc

@@ -12,15 +12,15 @@ Use Software Templates in {product} to provide standardized project starter kits
 
 include::../modules/shared/con-software-templates-in-rhdh.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-create-a-basic-software-template.adoc[leveloffset=+1]
+include::../modules/shared/proc-create-new-software-templates.adoc[leveloffset=+1]
 
 include::../modules/shared/ref-default-environment-parameters-and-secrets.adoc[leveloffset=+1]
 
-include::../modules/shared/ref-sample-software-template.adoc[leveloffset=+1]
+include::../modules/shared/ref-use-sample-templates.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-share-software-templates-with-your-organization.adoc[leveloffset=+1]
+include::../modules/shared/proc-publish-template-definitions-to-the-catalog.adoc[leveloffset=+1]
 
-include::../modules/shared/ref-extending-software-templates-for-complex-project-requirements.adoc[leveloffset=+1]
+include::../modules/shared/ref-extend-templates-using-conditional-logic-and-external-fetch-capabilities.adoc[leveloffset=+1]
 
 :context: {previouscontext}
 :!previouscontext:

assemblies/configure_customizing-rhdh/assembly-track-component-origin-and-software-template-version.adoc

@@ -14,9 +14,9 @@ Platform engineers use custom actions within the Software Template scaffolding p
 
 Platform administrators use custom actions such as `catalog:scaffolded-from` and `catalog:template:version` in the Scaffolder backend module to track the template version and the corresponding entity version, which simplifies lifecycle management.
 
-include::../modules/shared/proc-configure-provenance-and-software-template-versioning-rhdh.adoc[leveloffset=+1]
+include::../modules/shared/proc-configure-provenance-annotations.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-view-software-template-dependencies.adoc[leveloffset=+1]
+include::../modules/shared/proc-view-template-dependencies-in-the-catalog.adoc[leveloffset=+1]
 
 :context: {previouscontext}
 :!previouscontext:

assemblies/develop_streamline-software-development-and-management-in-rhdh/assembly-centralize-your-software-components-in-the-rhdh-catalog.adoc

@@ -21,19 +21,19 @@ The *Overview* page for a component provides key information such as links to th
 
 include::../modules/shared/proc-add-new-components-to-your-rhdh-instance.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-create-new-components-in-your-rhdh-instance.adoc[leveloffset=+2]
+include::../modules/shared/proc-generate-new-components.adoc[leveloffset=+2]
 
-include::../modules/shared/proc-register-components-manually-in-your-rhdh-instance.adoc[leveloffset=+2]
+include::../modules/shared/proc-register-existing-repositories-manually.adoc[leveloffset=+2]
 
-include::../modules/shared/proc-update-existing-components-in-your-rhdh-catalog.adoc[leveloffset=+1]
+include::../modules/shared/proc-update-component-yaml-metadata.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-find-components-by-kind-in-the-rhdh-catalog.adoc[leveloffset=+1]
+include::../modules/shared/proc-filter-the-catalog-by-entity-kind.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-filter-components-by-text-in-the-rhdh-catalog.adoc[leveloffset=+1]
+include::../modules/shared/proc-search-the-catalog-using-text-filters.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-review-the-yaml-configuration-of-your-rhdh-software-catalog.adoc[leveloffset=+1]
+include::../modules/shared/proc-review-the-raw-yaml-configuration.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-star-key-components-in-the-software-catalog.adoc[leveloffset=+1]
+include::../modules/shared/proc-star-frequently-used-components.adoc[leveloffset=+1]
 
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]

assemblies/develop_streamline-software-development-and-management-in-rhdh/assembly-import-your-team-s-codebase-from-git.adoc

@@ -12,12 +12,12 @@ ifdef::context[:parent-context: {context}]
 
 include::{docdir}/artifacts/snip-technology-preview.adoc[]
 
-include::../modules/shared/proc-enable-and-authorize-bulk-import-capabilities-in-rhdh.adoc[leveloffset=+1]
+include::../modules/shared/proc-enable-and-authorize-bulk-import-plugins.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-import-multiple-github-repositories.adoc[leveloffset=+1]
+include::../modules/shared/proc-select-and-import-github-repositories.adoc[leveloffset=+1]
 
 include::../modules/develop_streamline-software-development-and-management-in-rhdh/proc-manage-the-added-git-repositories.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-monitor-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1]
+include::../modules/shared/proc-monitor-bulk-import-operations-in-audit-logs.adoc[leveloffset=+1]
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]

assemblies/get-started_navigate-rhdh-on-your-first-day/assembly-manage-starred-items-for-quick-access.adoc

@@ -11,7 +11,7 @@ To streamline your daily workflow and reduce navigation time, use the starring f
 
 This personalization makes sure that you can locate the specific tools and documentation you use most often without performing repetitive searches across the software ecosystem.
 
-include::../modules/shared/proc-star-key-components-in-the-software-catalog.adoc[leveloffset=+1]
+include::../modules/shared/proc-star-frequently-used-components.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 == Additional resources

assemblies/shared/assembly-bulk-importing-from-github.adoc

@@ -13,15 +13,15 @@ include::{docdir}/artifacts/snip-technology-preview.adoc[]
 
 include::../modules/shared/con-repository-visibility-in-bulk-import.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-enable-and-authorize-bulk-import-capabilities-in-rhdh.adoc[leveloffset=+1]
+include::../modules/shared/proc-enable-and-authorize-bulk-import-plugins.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-import-multiple-github-repositories.adoc[leveloffset=+1]
+include::../modules/shared/proc-select-and-import-github-repositories.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-monitor-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1]
+include::../modules/shared/proc-monitor-bulk-import-operations-in-audit-logs.adoc[leveloffset=+1]
 
-include::../modules/shared/con-input-parameters-for-bulk-import-scaffolder-template.adoc[leveloffset=+1]
+include::../modules/shared/con-review-input-parameters.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-set-up-a-custom-scaffolder-workflow-for-bulk-import.adoc[leveloffset=+1]
+include::../modules/shared/proc-create-custom-scaffolder-workflows.adoc[leveloffset=+1]
 
 include::../modules/shared/proc-run-orchestrator-workflows-for-bulk-imports.adoc[leveloffset=+1]
 

assemblies/shared/assembly-bulk-importing-from-gitlab.adoc

@@ -13,15 +13,15 @@ include::{docdir}/artifacts/snip-technology-preview.adoc[]
 
 include::../modules/shared/con-repository-visibility-in-bulk-import.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-enable-and-authorize-bulk-import-capabilities-in-rhdh.adoc[leveloffset=+1]
+include::../modules/shared/proc-enable-and-authorize-bulk-import-plugins.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-import-multiple-gitlab-repositories.adoc[leveloffset=+1]
+include::../modules/shared/proc-manage-imported-repositories.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-monitor-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1]
+include::../modules/shared/proc-monitor-bulk-import-operations-in-audit-logs.adoc[leveloffset=+1]
 
-include::../modules/shared/con-input-parameters-for-bulk-import-scaffolder-template.adoc[leveloffset=+1]
+include::../modules/shared/con-review-input-parameters.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-set-up-a-custom-scaffolder-workflow-for-bulk-import.adoc[leveloffset=+1]
+include::../modules/shared/proc-create-custom-scaffolder-workflows.adoc[leveloffset=+1]
 
 include::../modules/shared/proc-run-orchestrator-workflows-for-bulk-imports.adoc[leveloffset=+1]
 

assemblies/shared/assembly-bulk-importing-in-rhdh.adoc

@@ -13,17 +13,17 @@ include::{docdir}/artifacts/snip-technology-preview.adoc[]
 
 include::../modules/shared/con-repository-visibility-in-bulk-import.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-enable-and-authorize-bulk-import-capabilities-in-rhdh.adoc[leveloffset=+1]
+include::../modules/shared/proc-enable-and-authorize-bulk-import-plugins.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-import-multiple-github-repositories.adoc[leveloffset=+1]
+include::../modules/shared/proc-select-and-import-github-repositories.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-import-multiple-gitlab-repositories.adoc[leveloffset=+1]
+include::../modules/shared/proc-manage-imported-repositories.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-monitor-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1]
+include::../modules/shared/proc-monitor-bulk-import-operations-in-audit-logs.adoc[leveloffset=+1]
 
-include::../modules/shared/con-input-parameters-for-bulk-import-scaffolder-template.adoc[leveloffset=+1]
+include::../modules/shared/con-review-input-parameters.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-set-up-a-custom-scaffolder-workflow-for-bulk-import.adoc[leveloffset=+1]
+include::../modules/shared/proc-create-custom-scaffolder-workflows.adoc[leveloffset=+1]
 
 include::../modules/shared/proc-run-orchestrator-workflows-for-bulk-imports.adoc[leveloffset=+1]
 

assemblies/shared/assembly-import-and-use-an-existing-software-template-for-faster-development.adoc

@@ -11,11 +11,11 @@ To standardize and accelerate the creation of new software, use Software Templat
 
 Each template uses a YAML definition to present a functional interface for inputting project metadata. Software Templates run a sequential series of _actions_, such as scaffolding code or creating repositories, which you can configure to run conditionally based on user input.
 
-include::../modules/shared/proc-create-a-software-component-using-software-templates.adoc[leveloffset=+1]
+include::../modules/shared/proc-run-software-templates-from-the-ui.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-search-and-filter-software-templates-in-your-rhdh-instance.adoc[leveloffset=+1]
+include::../modules/shared/proc-browse-available-templates.adoc[leveloffset=+1]
 
-include::../modules/shared/proc-import-an-existing-software-template.adoc[leveloffset=+1]
+include::../modules/shared/proc-import-an-existing-template-file-using-the-catalog-processor.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 [role="_additional-resources"]

modules/develop_streamline-software-development-and-management-in-rhdh/proc-manage-the-added-git-repositories.adoc

@@ -7,7 +7,7 @@
 You can oversee and manage the Git repositories that are imported to {product-short}.
 
 .Prerequisites
-* You have xref:import-multiple-github-repositories_{context}[imported GitHub repositories].
+* You have xref:select-and-import-github-repositories_{context}[imported GitHub repositories].
 
 
 .Procedure

modules/shared/con-input-parameters-for-bulk-import-scaffolder-template.adoc → modules/shared/con-review-input-parameters.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: CONCEPT
 
-[id="input-parameters-for-bulk-import-scaffolder-template_{context}"]
-= Input parameters for Bulk Import Scaffolder template
+[id="review-input-parameters_{context}"]
+= Review input parameters
 
 [role="_abstract"]
 Define Scaffolder template parameters such as repository URL, name, organization, and branch details to customize bulk import automation workflows for your repositories.

modules/shared/proc-search-and-filter-software-templates-in-your-rhdh-instance.adoc → modules/shared/proc-browse-available-templates.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="search-and-filter-software-templates-in-your-rhdh-instance_{context}"]
-= Search and filter Software Templates in your {product} instance
+[id="browse-available-templates_{context}"]
+= Browse available templates
 
 [role="_abstract"]
 Search and filter the available Software Templates to quickly locate the correct configuration for your project.

modules/shared/proc-configure-provenance-and-software-template-versioning-rhdh.adoc → modules/shared/proc-configure-provenance-annotations.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="configure-provenance-and-software-template-versioning-rhdh_{context}"]
-= Configure provenance and Software Template versioning {product}
+[id="configure-provenance-annotations_{context}"]
+= Configure provenance annotations
 
 [role="_abstract"]
 Modify the Software Template YAML definition to add provenance information during the scaffolding process.

modules/shared/proc-set-up-a-custom-scaffolder-workflow-for-bulk-import.adoc → modules/shared/proc-create-custom-scaffolder-workflows.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="set-up-a-custom-scaffolder-workflow-for-bulk-import_{context}"]
-= Set up a custom Scaffolder workflow for Bulk Import
+[id="create-custom-scaffolder-workflows_{context}"]
+= Create custom Scaffolder workflows
 
 [role="_abstract"]
 Create custom Scaffolder templates aligned with your organization's repository conventions to automate bulk import tasks such as entity imports, pull request creation, and webhook integration.

modules/shared/proc-create-a-basic-software-template.adoc → modules/shared/proc-create-new-software-templates.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="create-a-basic-software-template_{context}"]
-= Create a basic software template
+[id="create-new-software-templates_{context}"]
+= Create new Software Templates
 
 [role="_abstract"]
 To automate the setup of standardized environments for your developers, you must create a template definition. This definition allows {product-very-short} to automate the repetitive tasks of repository creation and initial configuration.

modules/shared/proc-enable-and-authorize-bulk-import-capabilities-in-rhdh.adoc → modules/shared/proc-enable-and-authorize-bulk-import-plugins.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="enable-and-authorize-bulk-import-capabilities-in-rhdh_{context}"]
-= Enable and authorize Bulk Import capabilities in {product}
+[id="enable-and-authorize-bulk-import-plugins_{context}"]
+= Enable and authorize bulk import plugins
 
 [role="_abstract"]
 Enable Bulk Import plugins and configure RBAC permissions to allow users to import multiple GitHub repositories and GitLab projects into the catalog.

modules/shared/proc-enable-automated-template-updates.adoc → modules/shared/proc-enable-the-scaffolder-relation-processor.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="enable-automated-template-updates_{context}"]
-= Enable automated template updates
+[id="enable-the-scaffolder-relation-processor_{context}"]
+= Enable the scaffolder-relation-processor
 
 [role="_abstract"]
 Configure the scaffolder-relation-processor plugin to synchronize Software Template changes to downstream repositories.

modules/shared/proc-enable-software-template-version-update-notifications-in-rhdh.adoc → modules/shared/proc-enable-update-notifications.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="enable-software-template-version-update-notifications-in-rhdh_{context}"]
-= Enable Software Template version update notifications in {product}
+[id="enable-update-notifications_{context}"]
+= Enable update notifications
 
 [role="_abstract"]
 Enable notification alerts for template version updates so that component owners are automatically notified when the Software Template used to generate their components is updated to a new version.

modules/shared/proc-find-components-by-kind-in-the-rhdh-catalog.adoc → modules/shared/proc-filter-the-catalog-by-entity-kind.adoc

@@ -1,6 +1,6 @@
 :_mod-docs-content-type: PROCEDURE
-[id="find-components-by-kind-in-the-rhdh-catalog_{context}"]
-= Find components by Kind in the {product} catalog
+[id="filter-the-catalog-by-entity-kind_{context}"]
+= Filter the catalog by entity kind
 
 [role="_abstract"]
 Filter the Software Catalog to display components by their type, such as Component, API, or Template.

modules/shared/proc-create-new-components-in-your-rhdh-instance.adoc → modules/shared/proc-generate-new-components.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="create-new-components-in-your-rhdh-instance_{context}"]
-= Create new components in your {product} instance
+[id="generate-new-components_{context}"]
+= Generate new components
 
 [role="_abstract"]
 You can create new components in the Software Catalog in your {product-very-short} instance. {product} automatically registers all components that developers or platform engineers create using Templates in the Software Catalog.

modules/shared/proc-import-an-existing-software-template.adoc → modules/shared/proc-import-an-existing-template-file-using-the-catalog-processor.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="import-an-existing-software-template_{context}"]
-= Import an existing Software Template
+[id="import-an-existing-template-file-using-the-catalog-processor_{context}"]
+= Import an existing template file using the Catalog Processor
 
 [role="_abstract"]
 You can use the *Catalog Processor* to import an existing Software Template into your {product} instance.

modules/shared/proc-import-multiple-gitlab-repositories.adoc → modules/shared/proc-manage-imported-repositories.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="import-multiple-gitlab-repositories_{context}"]
-= Import multiple GitLab repositories
+[id="manage-imported-repositories_{context}"]
+= Manage imported repositories
 
 [role="_abstract"]
 Select and import multiple GitLab projects that you can access into the {product} catalog, automatically creating merge requests with required catalog-info.yaml files.

modules/shared/proc-monitor-bulk-import-actions-using-audit-logs.adoc → modules/shared/proc-monitor-bulk-import-operations-in-audit-logs.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="monitor-bulk-import-actions-using-audit-logs_{context}"]
-= Monitor Bulk Import actions using audit logs
+[id="monitor-bulk-import-operations-in-audit-logs_{context}"]
+= Monitor bulk import operations in audit logs
 
 [role="_abstract"]
 Review Bulk Import backend plugin audit log events to monitor repository import operations, track API requests, and troubleshoot import issues.

modules/shared/proc-share-software-templates-with-your-organization.adoc → modules/shared/proc-publish-template-definitions-to-the-catalog.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="share-software-templates-with-your-organization_{context}"]
-= Share software templates with your organization
+[id="publish-template-definitions-to-the-catalog_{context}"]
+= Publish template definitions to the catalog
 
 [role="_abstract"]
 To allow developers to create new projects independently using your standards, you must publish the Software Template definition to the {product-very-short} catalog. This registration makes the template a selectable option in the software creator interface.

modules/shared/proc-register-components-manually-in-your-rhdh-instance.adoc → modules/shared/proc-register-existing-repositories-manually.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="register-components-manually-in-your-rhdh-instance_{context}"]
-= Register components manually in your {product-very-short} instance
+[id="register-existing-repositories-manually_{context}"]
+= Register existing repositories manually
 
 [role="_abstract"]
 To manually register components in your {product-very-short} instance, create a `catalog-info.yaml` file and register it with your {product} instance.

modules/shared/proc-review-the-yaml-configuration-of-your-rhdh-software-catalog.adoc → modules/shared/proc-review-the-raw-yaml-configuration.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="review-the-yaml-configuration-of-your-rhdh-software-catalog_{context}"]
-= Review the YAML configuration of your {product} Software Catalog
+[id="review-the-raw-yaml-configuration_{context}"]
+= Review the raw YAML configuration
 
 [role="_abstract"]
 You can view the Software Catalog YAML file in your {product} instance to review the metadata for the components in your Software Catalog.

modules/shared/proc-create-a-software-component-using-software-templates.adoc → modules/shared/proc-run-software-templates-from-the-ui.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="create-a-software-component-using-software-templates_{context}"]
-= Create a software component using Software Templates
+[id="run-software-templates-from-the-ui_{context}"]
+= Run Software Templates from the UI
 
 [role="_abstract"]
 To ensure project consistency and reduce manual configuration time, use Software Templates to create new components.

modules/shared/proc-filter-components-by-text-in-the-rhdh-catalog.adoc → modules/shared/proc-search-the-catalog-using-text-filters.adoc

@@ -3,8 +3,8 @@
 // Module included in the following assemblies:
 //
 // * assemblies/assembly-about-software-catalogs.adoc
-[id="filter-components-by-text-in-the-rhdh-catalog_{context}"]
-= Filter components by text in the {product} catalog
+[id="search-the-catalog-using-text-filters_{context}"]
+= Search the catalog using text filters
 
 [role="_abstract"]
 Search and filter components by text in the Software Catalog to quickly locate specific services, libraries, or other entities.