diff --git a/assemblies/configure_customizing-rhdh/assembly-about-software-templates.adoc b/assemblies/configure_customizing-rhdh/assembly-about-software-templates.adoc index 37fd96e9d2..825d55cb23 100644 --- a/assemblies/configure_customizing-rhdh/assembly-about-software-templates.adoc +++ b/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"] diff --git a/assemblies/configure_customizing-rhdh/assembly-automated-software-template-lifecycle-management.adoc b/assemblies/configure_customizing-rhdh/assembly-automated-software-template-lifecycle-management.adoc index 4748abfced..031257e089 100644 --- a/assemblies/configure_customizing-rhdh/assembly-automated-software-template-lifecycle-management.adoc +++ b/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} diff --git a/assemblies/configure_customizing-rhdh/assembly-standardize-project-development-with-software-templates.adoc b/assemblies/configure_customizing-rhdh/assembly-standardize-project-development-with-software-templates.adoc index ee8a930a68..8844002619 100644 --- a/assemblies/configure_customizing-rhdh/assembly-standardize-project-development-with-software-templates.adoc +++ b/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: diff --git a/assemblies/configure_customizing-rhdh/assembly-track-component-origin-and-software-template-version.adoc b/assemblies/configure_customizing-rhdh/assembly-track-component-origin-and-software-template-version.adoc index f8b520cbda..402fbdb8dc 100644 --- a/assemblies/configure_customizing-rhdh/assembly-track-component-origin-and-software-template-version.adoc +++ b/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: diff --git a/assemblies/develop_streamline-software-development-and-management-in-rhdh/assembly-centralize-your-software-components-in-the-rhdh-catalog.adoc b/assemblies/develop_streamline-software-development-and-management-in-rhdh/assembly-centralize-your-software-components-in-the-rhdh-catalog.adoc index de90a1b5dd..a32b20bcd9 100644 --- a/assemblies/develop_streamline-software-development-and-management-in-rhdh/assembly-centralize-your-software-components-in-the-rhdh-catalog.adoc +++ b/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:] diff --git a/assemblies/develop_streamline-software-development-and-management-in-rhdh/assembly-import-your-team-s-codebase-from-git.adoc b/assemblies/develop_streamline-software-development-and-management-in-rhdh/assembly-import-your-team-s-codebase-from-git.adoc index a1c197d7dd..2ab65d853d 100644 --- a/assemblies/develop_streamline-software-development-and-management-in-rhdh/assembly-import-your-team-s-codebase-from-git.adoc +++ b/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:] diff --git a/assemblies/get-started_navigate-rhdh-on-your-first-day/assembly-manage-starred-items-for-quick-access.adoc b/assemblies/get-started_navigate-rhdh-on-your-first-day/assembly-manage-starred-items-for-quick-access.adoc index e0fd18ea8a..91cbd9ddbb 100644 --- a/assemblies/get-started_navigate-rhdh-on-your-first-day/assembly-manage-starred-items-for-quick-access.adoc +++ b/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 diff --git a/assemblies/shared/assembly-bulk-importing-from-github.adoc b/assemblies/shared/assembly-bulk-importing-from-github.adoc index 6f81491a6d..4f55262551 100644 --- a/assemblies/shared/assembly-bulk-importing-from-github.adoc +++ b/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] diff --git a/assemblies/shared/assembly-bulk-importing-from-gitlab.adoc b/assemblies/shared/assembly-bulk-importing-from-gitlab.adoc index f571615d92..b2472fd9ad 100644 --- a/assemblies/shared/assembly-bulk-importing-from-gitlab.adoc +++ b/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] diff --git a/assemblies/shared/assembly-bulk-importing-in-rhdh.adoc b/assemblies/shared/assembly-bulk-importing-in-rhdh.adoc index e7484dc757..ce669d7f54 100644 --- a/assemblies/shared/assembly-bulk-importing-in-rhdh.adoc +++ b/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] diff --git a/assemblies/shared/assembly-import-and-use-an-existing-software-template-for-faster-development.adoc b/assemblies/shared/assembly-import-and-use-an-existing-software-template-for-faster-development.adoc index e8744492de..88d327480a 100644 --- a/assemblies/shared/assembly-import-and-use-an-existing-software-template-for-faster-development.adoc +++ b/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"] diff --git a/modules/develop_streamline-software-development-and-management-in-rhdh/proc-manage-the-added-git-repositories.adoc b/modules/develop_streamline-software-development-and-management-in-rhdh/proc-manage-the-added-git-repositories.adoc index ad4c3243e1..04205d6d54 100644 --- a/modules/develop_streamline-software-development-and-management-in-rhdh/proc-manage-the-added-git-repositories.adoc +++ b/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 diff --git a/modules/shared/con-input-parameters-for-bulk-import-scaffolder-template.adoc b/modules/shared/con-review-input-parameters.adoc similarity index 93% rename from modules/shared/con-input-parameters-for-bulk-import-scaffolder-template.adoc rename to modules/shared/con-review-input-parameters.adoc index bf2d060502..e0fbf42339 100644 --- a/modules/shared/con-input-parameters-for-bulk-import-scaffolder-template.adoc +++ b/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. diff --git a/modules/shared/proc-search-and-filter-software-templates-in-your-rhdh-instance.adoc b/modules/shared/proc-browse-available-templates.adoc similarity index 73% rename from modules/shared/proc-search-and-filter-software-templates-in-your-rhdh-instance.adoc rename to modules/shared/proc-browse-available-templates.adoc index 8026533e82..00090df7d3 100644 --- a/modules/shared/proc-search-and-filter-software-templates-in-your-rhdh-instance.adoc +++ b/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. diff --git a/modules/shared/proc-configure-provenance-and-software-template-versioning-rhdh.adoc b/modules/shared/proc-configure-provenance-annotations.adoc similarity index 95% rename from modules/shared/proc-configure-provenance-and-software-template-versioning-rhdh.adoc rename to modules/shared/proc-configure-provenance-annotations.adoc index 465c76f51a..893bc39299 100644 --- a/modules/shared/proc-configure-provenance-and-software-template-versioning-rhdh.adoc +++ b/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. diff --git a/modules/shared/proc-set-up-a-custom-scaffolder-workflow-for-bulk-import.adoc b/modules/shared/proc-create-custom-scaffolder-workflows.adoc similarity index 95% rename from modules/shared/proc-set-up-a-custom-scaffolder-workflow-for-bulk-import.adoc rename to modules/shared/proc-create-custom-scaffolder-workflows.adoc index 4d5b3645ef..44fa4cfa1f 100644 --- a/modules/shared/proc-set-up-a-custom-scaffolder-workflow-for-bulk-import.adoc +++ b/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. diff --git a/modules/shared/proc-create-a-basic-software-template.adoc b/modules/shared/proc-create-new-software-templates.adoc similarity index 95% rename from modules/shared/proc-create-a-basic-software-template.adoc rename to modules/shared/proc-create-new-software-templates.adoc index 65f9749028..5c8d8dfb64 100644 --- a/modules/shared/proc-create-a-basic-software-template.adoc +++ b/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. diff --git a/modules/shared/proc-enable-and-authorize-bulk-import-capabilities-in-rhdh.adoc b/modules/shared/proc-enable-and-authorize-bulk-import-plugins.adoc similarity index 94% rename from modules/shared/proc-enable-and-authorize-bulk-import-capabilities-in-rhdh.adoc rename to modules/shared/proc-enable-and-authorize-bulk-import-plugins.adoc index c719c82f48..a8059ec531 100644 --- a/modules/shared/proc-enable-and-authorize-bulk-import-capabilities-in-rhdh.adoc +++ b/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. diff --git a/modules/shared/proc-enable-automated-template-updates.adoc b/modules/shared/proc-enable-the-scaffolder-relation-processor.adoc similarity index 95% rename from modules/shared/proc-enable-automated-template-updates.adoc rename to modules/shared/proc-enable-the-scaffolder-relation-processor.adoc index 1991253e81..f42024cb62 100644 --- a/modules/shared/proc-enable-automated-template-updates.adoc +++ b/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. diff --git a/modules/shared/proc-enable-software-template-version-update-notifications-in-rhdh.adoc b/modules/shared/proc-enable-update-notifications.adoc similarity index 91% rename from modules/shared/proc-enable-software-template-version-update-notifications-in-rhdh.adoc rename to modules/shared/proc-enable-update-notifications.adoc index 6bc2d35d65..fa418037f8 100644 --- a/modules/shared/proc-enable-software-template-version-update-notifications-in-rhdh.adoc +++ b/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. diff --git a/modules/shared/proc-find-components-by-kind-in-the-rhdh-catalog.adoc b/modules/shared/proc-filter-the-catalog-by-entity-kind.adoc similarity index 85% rename from modules/shared/proc-find-components-by-kind-in-the-rhdh-catalog.adoc rename to modules/shared/proc-filter-the-catalog-by-entity-kind.adoc index d386fba719..6637449e93 100644 --- a/modules/shared/proc-find-components-by-kind-in-the-rhdh-catalog.adoc +++ b/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. diff --git a/modules/shared/proc-create-new-components-in-your-rhdh-instance.adoc b/modules/shared/proc-generate-new-components.adoc similarity index 85% rename from modules/shared/proc-create-new-components-in-your-rhdh-instance.adoc rename to modules/shared/proc-generate-new-components.adoc index 90342edc3c..bd83113247 100644 --- a/modules/shared/proc-create-new-components-in-your-rhdh-instance.adoc +++ b/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. diff --git a/modules/shared/proc-import-an-existing-software-template.adoc b/modules/shared/proc-import-an-existing-template-file-using-the-catalog-processor.adoc similarity index 90% rename from modules/shared/proc-import-an-existing-software-template.adoc rename to modules/shared/proc-import-an-existing-template-file-using-the-catalog-processor.adoc index 927fa7a671..c2e2ea191d 100644 --- a/modules/shared/proc-import-an-existing-software-template.adoc +++ b/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. diff --git a/modules/shared/proc-import-multiple-gitlab-repositories.adoc b/modules/shared/proc-manage-imported-repositories.adoc similarity index 96% rename from modules/shared/proc-import-multiple-gitlab-repositories.adoc rename to modules/shared/proc-manage-imported-repositories.adoc index e8ea75214e..db32371ef7 100644 --- a/modules/shared/proc-import-multiple-gitlab-repositories.adoc +++ b/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. diff --git a/modules/shared/proc-monitor-bulk-import-actions-using-audit-logs.adoc b/modules/shared/proc-monitor-bulk-import-operations-in-audit-logs.adoc similarity index 96% rename from modules/shared/proc-monitor-bulk-import-actions-using-audit-logs.adoc rename to modules/shared/proc-monitor-bulk-import-operations-in-audit-logs.adoc index b4d00b8a26..cc1174e2c2 100644 --- a/modules/shared/proc-monitor-bulk-import-actions-using-audit-logs.adoc +++ b/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. diff --git a/modules/shared/proc-share-software-templates-with-your-organization.adoc b/modules/shared/proc-publish-template-definitions-to-the-catalog.adoc similarity index 88% rename from modules/shared/proc-share-software-templates-with-your-organization.adoc rename to modules/shared/proc-publish-template-definitions-to-the-catalog.adoc index 967b62a88b..02c13553a3 100644 --- a/modules/shared/proc-share-software-templates-with-your-organization.adoc +++ b/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. diff --git a/modules/shared/proc-register-components-manually-in-your-rhdh-instance.adoc b/modules/shared/proc-register-existing-repositories-manually.adoc similarity index 92% rename from modules/shared/proc-register-components-manually-in-your-rhdh-instance.adoc rename to modules/shared/proc-register-existing-repositories-manually.adoc index e90eb133a0..49d4d5c012 100644 --- a/modules/shared/proc-register-components-manually-in-your-rhdh-instance.adoc +++ b/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. diff --git a/modules/shared/proc-review-the-yaml-configuration-of-your-rhdh-software-catalog.adoc b/modules/shared/proc-review-the-raw-yaml-configuration.adoc similarity index 75% rename from modules/shared/proc-review-the-yaml-configuration-of-your-rhdh-software-catalog.adoc rename to modules/shared/proc-review-the-raw-yaml-configuration.adoc index f7a213a635..0a9ac6e655 100644 --- a/modules/shared/proc-review-the-yaml-configuration-of-your-rhdh-software-catalog.adoc +++ b/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. diff --git a/modules/shared/proc-create-a-software-component-using-software-templates.adoc b/modules/shared/proc-run-software-templates-from-the-ui.adoc similarity index 91% rename from modules/shared/proc-create-a-software-component-using-software-templates.adoc rename to modules/shared/proc-run-software-templates-from-the-ui.adoc index c6f0e0b4e6..a1a0f9104f 100644 --- a/modules/shared/proc-create-a-software-component-using-software-templates.adoc +++ b/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. diff --git a/modules/shared/proc-filter-components-by-text-in-the-rhdh-catalog.adoc b/modules/shared/proc-search-the-catalog-using-text-filters.adoc similarity index 82% rename from modules/shared/proc-filter-components-by-text-in-the-rhdh-catalog.adoc rename to modules/shared/proc-search-the-catalog-using-text-filters.adoc index 976c05f234..55ad4e9bd9 100644 --- a/modules/shared/proc-filter-components-by-text-in-the-rhdh-catalog.adoc +++ b/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. diff --git a/modules/shared/proc-import-multiple-github-repositories.adoc b/modules/shared/proc-select-and-import-github-repositories.adoc similarity index 88% rename from modules/shared/proc-import-multiple-github-repositories.adoc rename to modules/shared/proc-select-and-import-github-repositories.adoc index 0c33ccde7f..9862dde459 100644 --- a/modules/shared/proc-import-multiple-github-repositories.adoc +++ b/modules/shared/proc-select-and-import-github-repositories.adoc @@ -1,13 +1,13 @@ :_mod-docs-content-type: PROCEDURE -[id="import-multiple-github-repositories_{context}"] -= Import multiple GitHub repositories +[id="select-and-import-github-repositories_{context}"] += Select and import GitHub repositories [role="_abstract"] Select and import multiple GitHub repositories that you can access into the {product} catalog, automatically creating pull requests with required catalog-info.yaml files. .Prerequisites -* You have xref:enable-and-authorize-bulk-import-capabilities-in-rhdh_{context}[enabled the Bulk Import feature and configured access permissions]. +* You have xref:enable-and-authorize-bulk-import-plugins_{context}[enabled the Bulk Import feature and configured access permissions]. * You have {authentication-book-link}#enabling-user-authentication-with-github[authenticated to {product-short} using GitHub as your authentication provider]. [NOTE] diff --git a/modules/shared/proc-star-key-components-in-the-software-catalog.adoc b/modules/shared/proc-star-frequently-used-components.adoc similarity index 81% rename from modules/shared/proc-star-key-components-in-the-software-catalog.adoc rename to modules/shared/proc-star-frequently-used-components.adoc index 58cd21de41..eb1d8957da 100644 --- a/modules/shared/proc-star-key-components-in-the-software-catalog.adoc +++ b/modules/shared/proc-star-frequently-used-components.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="star-key-components-in-the-software-catalog_{context}"] -= Star key components in the Software Catalog +[id="star-frequently-used-components_{context}"] += Star frequently used components [role="_abstract"] You can add commonly used components to the *Your Starred Entities* card for quick access. diff --git a/modules/shared/proc-update-existing-components-in-your-rhdh-catalog.adoc b/modules/shared/proc-update-component-yaml-metadata.adoc similarity index 85% rename from modules/shared/proc-update-existing-components-in-your-rhdh-catalog.adoc rename to modules/shared/proc-update-component-yaml-metadata.adoc index ad52dc1c42..e952533159 100644 --- a/modules/shared/proc-update-existing-components-in-your-rhdh-catalog.adoc +++ b/modules/shared/proc-update-component-yaml-metadata.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="update-existing-components-in-your-rhdh-catalog_{context}"] -= Update existing components in your {product} catalog +[id="update-component-yaml-metadata_{context}"] += Update component YAML metadata [role="_abstract"] You can update components in the Software Catalog in your {product} instance. diff --git a/modules/shared/proc-version-a-software-template-in-rhdh.adoc b/modules/shared/proc-version-software-templates.adoc similarity index 96% rename from modules/shared/proc-version-a-software-template-in-rhdh.adoc rename to modules/shared/proc-version-software-templates.adoc index 225d446302..cf6b468477 100644 --- a/modules/shared/proc-version-a-software-template-in-rhdh.adoc +++ b/modules/shared/proc-version-software-templates.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="version-a-software-template-in-rhdh_{context}"] -= Version a Software Template in {product} +[id="version-software-templates_{context}"] += Version Software Templates [role="_abstract"] Version Software Templates by using the `catalog:scaffolded-from` and `catalog:template:version` custom actions to track template versions and the entities created from them. diff --git a/modules/shared/proc-view-software-template-dependencies.adoc b/modules/shared/proc-view-template-dependencies-in-the-catalog.adoc similarity index 89% rename from modules/shared/proc-view-software-template-dependencies.adoc rename to modules/shared/proc-view-template-dependencies-in-the-catalog.adoc index 6c5573dbeb..d5e1e393a3 100644 --- a/modules/shared/proc-view-software-template-dependencies.adoc +++ b/modules/shared/proc-view-template-dependencies-in-the-catalog.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="view-software-template-dependencies_{context}"] -= View Software Template dependencies +[id="view-template-dependencies-in-the-catalog_{context}"] += View template dependencies in the catalog [role="_abstract"] View all entities created from a specific Software Template to identify the complete dependency and impact map. diff --git a/modules/shared/ref-extending-software-templates-for-complex-project-requirements.adoc b/modules/shared/ref-extend-templates-using-conditional-logic-and-external-fetch-capabilities.adoc similarity index 78% rename from modules/shared/ref-extending-software-templates-for-complex-project-requirements.adoc rename to modules/shared/ref-extend-templates-using-conditional-logic-and-external-fetch-capabilities.adoc index 1c32e3b807..79b0df592f 100644 --- a/modules/shared/ref-extending-software-templates-for-complex-project-requirements.adoc +++ b/modules/shared/ref-extend-templates-using-conditional-logic-and-external-fetch-capabilities.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE -[id="extending-software-templates-for-complex-project-requirements_{context}"] -= Extending software templates for complex project requirements +[id="extend-templates-using-conditional-logic-and-external-fetch-capabilities_{context}"] += Extend templates using conditional logic and external fetch capabilities [role="_abstract"] Use advanced logic to create Software Templates that adapt to specific project requirements and user inputs. Advanced templating includes parameterization, conditional logic, and fetch-and-run capabilities. diff --git a/modules/shared/ref-template-sync-considerations-and-limitations.adoc b/modules/shared/ref-template-sync-limitations.adoc similarity index 92% rename from modules/shared/ref-template-sync-considerations-and-limitations.adoc rename to modules/shared/ref-template-sync-limitations.adoc index aab027324e..d13635e70f 100644 --- a/modules/shared/ref-template-sync-considerations-and-limitations.adoc +++ b/modules/shared/ref-template-sync-limitations.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE -[id="template-sync-considerations-and-limitations_{context}"] -= Template sync considerations and limitations +[id="template-sync-limitations_{context}"] += Template sync limitations [role="_abstract"] Review reviewer assignment, variable resolution limitations, and other details to troubleshoot the synchronization process. diff --git a/modules/shared/ref-sample-software-template.adoc b/modules/shared/ref-use-sample-templates.adoc similarity index 95% rename from modules/shared/ref-sample-software-template.adoc rename to modules/shared/ref-use-sample-templates.adoc index 128df1277e..b0945bde71 100644 --- a/modules/shared/ref-sample-software-template.adoc +++ b/modules/shared/ref-use-sample-templates.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE -[id="sample-software-template_{context}"] -= Sample software template +[id="use-sample-templates_{context}"] += Use sample templates [role="_abstract"] This sample Software Template defines project parameters and publishes the generated code to a GitHub repository. diff --git a/titles/product_product/category-maps/develop/con-automate-repository-onboarding-to-the-catalog.adoc b/titles/product_product/category-maps/develop/con-automate-repository-onboarding-to-the-catalog.adoc index a3a5b96e97..a87510bb48 100644 --- a/titles/product_product/category-maps/develop/con-automate-repository-onboarding-to-the-catalog.adoc +++ b/titles/product_product/category-maps/develop/con-automate-repository-onboarding-to-the-catalog.adoc @@ -3,4 +3,6 @@ = Automate repository onboarding to the catalog [role="_abstract"] -TODO: Replace this placeholder with an overview of Automate repository onboarding to the catalog. +Automate onboarding of GitHub repositories and GitLab projects to {product} catalog, and monitor import status by using bulk import capabilities. + +include::{docdir}/artifacts/snip-technology-preview.adoc[] diff --git a/titles/product_product/category-maps/develop/con-automate-template-lifecycle-management.adoc b/titles/product_product/category-maps/develop/con-automate-template-lifecycle-management.adoc index ee7b720210..902f38ebb7 100644 --- a/titles/product_product/category-maps/develop/con-automate-template-lifecycle-management.adoc +++ b/titles/product_product/category-maps/develop/con-automate-template-lifecycle-management.adoc @@ -3,4 +3,8 @@ = Automate template lifecycle management [role="_abstract"] -TODO: Replace this placeholder with an overview of Automate template lifecycle management. +Automatically apply template updates to all downstream repositories to maintain compliance without manual file comparisons. + +When Software Templates receive security updates or configuration changes, you can apply those updates to all downstream repositories automatically so that your applications remain compliant without manual file comparisons. + +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. diff --git a/titles/product_product/category-maps/develop/con-automate-workflow-deployments.adoc b/titles/product_product/category-maps/develop/con-automate-workflow-deployments.adoc index fc80699e84..1f05e893b8 100644 --- a/titles/product_product/category-maps/develop/con-automate-workflow-deployments.adoc +++ b/titles/product_product/category-maps/develop/con-automate-workflow-deployments.adoc @@ -3,4 +3,4 @@ = Automate workflow deployments [role="_abstract"] -TODO: Replace this placeholder with an overview of Automate workflow deployments. +Automate the software development lifecycle for serverless workflows by using Orchestrator software templates to bootstrap complete workflow projects with Git repositories, deployment configurations, and CI/CD pipelines. diff --git a/titles/product_product/category-maps/develop/con-build-serverless-workflows.adoc b/titles/product_product/category-maps/develop/con-build-serverless-workflows.adoc index a96b847dd7..a1e2c7c92a 100644 --- a/titles/product_product/category-maps/develop/con-build-serverless-workflows.adoc +++ b/titles/product_product/category-maps/develop/con-build-serverless-workflows.adoc @@ -3,4 +3,10 @@ = Build serverless workflows [role="_abstract"] -TODO: Replace this placeholder with an overview of Build serverless workflows. +Deploy a workflow and make it available in the Orchestrator plugin by building workflow images, generating workflow manifests, and deploying workflows to a cluster. + +* Building workflow images +* Generating workflow manifests +* Deploying workflows to a cluster + +This process moves the workflow from your local machine to deployment on a cluster. diff --git a/titles/product_product/category-maps/develop/con-build-workflow-container-images-locally-using-the-build-sh-script.adoc b/titles/product_product/category-maps/develop/con-build-workflow-container-images-locally-using-the-build-sh-script.adoc index 44a8b6d39f..9b3a8f1716 100644 --- a/titles/product_product/category-maps/develop/con-build-workflow-container-images-locally-using-the-build-sh-script.adoc +++ b/titles/product_product/category-maps/develop/con-build-workflow-container-images-locally-using-the-build-sh-script.adoc @@ -3,4 +3,4 @@ = Build workflow container images locally using the build.sh script [role="_abstract"] -TODO: Replace this placeholder with an overview of Build workflow container images locally using the build.sh script. +Deploy a workflow and make it available in the Orchestrator plugin by building workflow images, generating workflow manifests, and deploying workflows to a cluster. diff --git a/titles/product_product/category-maps/develop/con-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc b/titles/product_product/category-maps/develop/con-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc index 2dfbf26a23..d86d023a8c 100644 --- a/titles/product_product/category-maps/develop/con-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc +++ b/titles/product_product/category-maps/develop/con-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc @@ -3,4 +3,4 @@ = Configure Amazon S3 or OpenShift Data Foundation buckets [role="_abstract"] -TODO: Replace this placeholder with an overview of Configure Amazon S3 or OpenShift Data Foundation buckets. +The TechDocs plugin is preinstalled and enabled on a {product-short} instance by default. You can configure TechDocs to use cloud storage for storing generated documentation files. diff --git a/titles/product_product/category-maps/develop/con-configure-bulk-import-capabilities.adoc b/titles/product_product/category-maps/develop/con-configure-bulk-import-capabilities.adoc index 65c454cb52..5c0a4567f7 100644 --- a/titles/product_product/category-maps/develop/con-configure-bulk-import-capabilities.adoc +++ b/titles/product_product/category-maps/develop/con-configure-bulk-import-capabilities.adoc @@ -3,4 +3,4 @@ = Configure bulk import capabilities [role="_abstract"] -TODO: Replace this placeholder with an overview of Configure bulk import capabilities. +Automate onboarding of GitHub repositories and GitLab projects to {product} catalog, and monitor import status by using bulk import capabilities. diff --git a/titles/product_product/category-maps/develop/con-configure-techdocs-storage-and-cicd-pipelines.adoc b/titles/product_product/category-maps/develop/con-configure-techdocs-storage-and-cicd-pipelines.adoc index 8113f5a14b..a5f71e44fb 100644 --- a/titles/product_product/category-maps/develop/con-configure-techdocs-storage-and-cicd-pipelines.adoc +++ b/titles/product_product/category-maps/develop/con-configure-techdocs-storage-and-cicd-pipelines.adoc @@ -3,4 +3,13 @@ = Configure TechDocs storage and CI/CD pipelines [role="_abstract"] -TODO: Replace this placeholder with an overview of Configure TechDocs storage and CI/CD pipelines. +The TechDocs plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the TechDocs plugin, and change other parameters, by configuring the {product} Helm chart or the {product} Operator ConfigMap. + +[IMPORTANT] +==== +{product} includes a built-in TechDocs builder that generates static HTML documentation from your codebase. However, the default basic setup of the local builder is not intended for production. +==== + +You can use a CI/CD pipeline with the repository that has a dedicated job to generate docs for TechDocs. The generated static files are stored in {odf-name} or in a cloud storage solution of your choice and published to a static HTML documentation site. + +After you configure {odf-name} to store the files that TechDocs generates, you can configure the TechDocs plugin to use the {odf-name} for cloud storage. diff --git a/titles/product_product/category-maps/develop/con-develop.adoc b/titles/product_product/category-maps/develop/con-develop.adoc index 688edce5f8..87739d5e6c 100644 --- a/titles/product_product/category-maps/develop/con-develop.adoc +++ b/titles/product_product/category-maps/develop/con-develop.adoc @@ -3,4 +3,4 @@ = Develop [role="_abstract"] -TODO: Replace this placeholder with an overview of Develop. +Use {product} to streamline software development through centralized component management, standardized templates, automated onboarding, workflow orchestration, and documentation as code. diff --git a/titles/product_product/category-maps/develop/con-disable-or-remove-techdocs-add-ons.adoc b/titles/product_product/category-maps/develop/con-disable-or-remove-techdocs-add-ons.adoc index 522cfe0bd7..836b21deb9 100644 --- a/titles/product_product/category-maps/develop/con-disable-or-remove-techdocs-add-ons.adoc +++ b/titles/product_product/category-maps/develop/con-disable-or-remove-techdocs-add-ons.adoc @@ -3,4 +3,8 @@ = Disable or remove TechDocs add-ons [role="_abstract"] -TODO: Replace this placeholder with an overview of Disable or remove TechDocs add-ons. +Remove or disable installed TechDocs add-ons from your {product} instance by using the Operator or the Helm chart. + +Administrators can remove installed TechDocs add-ons by using either the Operator or Helm chart, depending on the method used to install the add-on. If you used the Operator to install the add-on, remove it from the ConfigMap. If you used the Helm chart to install the add-on, remove it from the Helm chart. + +If you want to disable a plugin instead of removing it from your {product} instance, you can disable the plugin that you are using to import the TechDocs add-on. Since the `disabled` status is controlled at the plugin level, disabling the plugin disables all of the TechDocs add-ons in the specified plugin package. diff --git a/titles/product_product/category-maps/develop/con-import-source-code-repositories-in-bulk.adoc b/titles/product_product/category-maps/develop/con-import-source-code-repositories-in-bulk.adoc index 46ed6cad3b..11ef93a96c 100644 --- a/titles/product_product/category-maps/develop/con-import-source-code-repositories-in-bulk.adoc +++ b/titles/product_product/category-maps/develop/con-import-source-code-repositories-in-bulk.adoc @@ -3,4 +3,4 @@ = Import source code repositories in bulk [role="_abstract"] -TODO: Replace this placeholder with an overview of Import source code repositories in bulk. +Automate onboarding of GitHub repositories and GitLab projects to {product} catalog, and monitor import status by using bulk import capabilities. diff --git a/titles/product_product/category-maps/develop/con-install-external-or-third-party-add-ons.adoc b/titles/product_product/category-maps/develop/con-install-external-or-third-party-add-ons.adoc index ee376b56d9..76f00ddb9a 100644 --- a/titles/product_product/category-maps/develop/con-install-external-or-third-party-add-ons.adoc +++ b/titles/product_product/category-maps/develop/con-install-external-or-third-party-add-ons.adoc @@ -3,4 +3,4 @@ = Install external or third-party add-ons [role="_abstract"] -TODO: Replace this placeholder with an overview of Install external or third-party add-ons. +Install and configure TechDocs add-ons to extend the functionality of the TechDocs plugin in {product}. diff --git a/titles/product_product/category-maps/develop/con-install-orchestrator-helm-charts.adoc b/titles/product_product/category-maps/develop/con-install-orchestrator-helm-charts.adoc index cbfb9c9ed9..96a86c6ab2 100644 --- a/titles/product_product/category-maps/develop/con-install-orchestrator-helm-charts.adoc +++ b/titles/product_product/category-maps/develop/con-install-orchestrator-helm-charts.adoc @@ -3,4 +3,4 @@ = Install Orchestrator Helm charts [role="_abstract"] -TODO: Replace this placeholder with an overview of Install Orchestrator Helm charts. +Automate the software development lifecycle for serverless workflows by using Orchestrator software templates to bootstrap complete workflow projects with Git repositories, deployment configurations, and CI/CD pipelines. diff --git a/titles/product_product/category-maps/develop/con-install-orchestrator-in-an-air-gapped-environment.adoc b/titles/product_product/category-maps/develop/con-install-orchestrator-in-an-air-gapped-environment.adoc index d459acb59e..2bd39b9816 100644 --- a/titles/product_product/category-maps/develop/con-install-orchestrator-in-an-air-gapped-environment.adoc +++ b/titles/product_product/category-maps/develop/con-install-orchestrator-in-an-air-gapped-environment.adoc @@ -3,4 +3,4 @@ = Install Orchestrator in an air-gapped environment [role="_abstract"] -TODO: Replace this placeholder with an overview of Install Orchestrator in an air-gapped environment. +You can configure {product} ({product-very-short}) with the Orchestrator plugin in a fully disconnected or partially disconnected environment by using the Operator or Helm chart. diff --git a/titles/product_product/category-maps/develop/con-install-techdocs-add-ons.adoc b/titles/product_product/category-maps/develop/con-install-techdocs-add-ons.adoc index 1e28da2b9e..a09a82c3e7 100644 --- a/titles/product_product/category-maps/develop/con-install-techdocs-add-ons.adoc +++ b/titles/product_product/category-maps/develop/con-install-techdocs-add-ons.adoc @@ -3,4 +3,8 @@ = Install TechDocs add-ons [role="_abstract"] -TODO: Replace this placeholder with an overview of Install TechDocs add-ons. +Install and configure TechDocs add-ons to extend the functionality of the TechDocs plugin in {product}. + +TechDocs add-ons supported by {company-name} are exported to the TechDocs plugin by the `backstage-plugin-techdocs-module-addons-contrib` plugin package, which is preinstalled on {product} and enabled by default. The `` add-on is part of the default configuration of this plugin package and comes ready to use in the TechDocs plugin. + +You can install other supported TechDocs add-ons by configuring the `backstage-plugin-techdocs-module-addons-contrib` plugin package in the {product} ConfigMap or Helm chart, depending on whether you use the Operator or Helm chart for installation. If you want to customize your TechDocs experience beyond the functions of the supported add-ons, you can install third-party add-ons on your TechDocs plugin, including add-ons that you create yourself. diff --git a/titles/product_product/category-maps/develop/con-manage-your-software-components.adoc b/titles/product_product/category-maps/develop/con-manage-your-software-components.adoc index 914cd27190..77e6a388f8 100644 --- a/titles/product_product/category-maps/develop/con-manage-your-software-components.adoc +++ b/titles/product_product/category-maps/develop/con-manage-your-software-components.adoc @@ -3,4 +3,14 @@ = Manage your software components [role="_abstract"] -TODO: Replace this placeholder with an overview of Manage your software components. +The {product} Software Catalog is a centralized system that gives you visibility into all the software across your ecosystem, including services, websites, libraries, and data pipelines. + +The metadata for the components in your Software Catalog is stored as YAML files that live alongside your code in your version control system. The version control repositories can include one or many metadata files. Software Catalog organizes items as entities, which include Components, Resources, and APIs, and other related types. Each entity includes associated metadata such as its owner, type, and other relevant details. + +By storing metadata in YAML files alongside the code, you allow {product} to process and display this information through a clear, visual interface. With the Software Catalog, you can manage and maintain your software, stay aware of all software available in your ecosystem, and take ownership of your services and tools. + +//[Add a Software Catalog screenshot of the latest build] + +The *Overview* page for a component provides key information such as links to the source code, documentation, dependencies, and ownership details. You can customize this page with plugins to suit specific needs. + +//[Add any Component screenshot of the latest build] diff --git a/titles/product_product/category-maps/develop/con-orchestrate-infrastructure-tasks-using-workflows.adoc b/titles/product_product/category-maps/develop/con-orchestrate-infrastructure-tasks-using-workflows.adoc index bb33aaf6c8..b54ad7b5a7 100644 --- a/titles/product_product/category-maps/develop/con-orchestrate-infrastructure-tasks-using-workflows.adoc +++ b/titles/product_product/category-maps/develop/con-orchestrate-infrastructure-tasks-using-workflows.adoc @@ -3,4 +3,13 @@ = Orchestrate infrastructure tasks using workflows [role="_abstract"] -TODO: Replace this placeholder with an overview of Orchestrate infrastructure tasks using workflows. +You can streamline and automate your work by using the Orchestrator in {product} to design, run, and monitor workflows across applications and services. + +* Design, run, and monitor workflows to simplify multi-step processes across applications and services. +* Standardize onboarding, migration, and integration workflows to reduce manual effort and improve consistency. +* Extend {product-very-short} with enterprise-grade Orchestration features to support collaboration and scalability. + +[NOTE] +==== +Orchestrator currently supports only {ocp-brand-name} ({ocp-short}); it is not available on {aks-brand-name} ({aks-short}), {eks-brand-name} ({eks-short}), or {gke-brand-name} ({gke-short}). +==== diff --git a/titles/product_product/category-maps/develop/con-orchestrator-process-automation-architecture.adoc b/titles/product_product/category-maps/develop/con-orchestrator-process-automation-architecture.adoc index bc638c27c6..226d533f8a 100644 --- a/titles/product_product/category-maps/develop/con-orchestrator-process-automation-architecture.adoc +++ b/titles/product_product/category-maps/develop/con-orchestrator-process-automation-architecture.adoc @@ -3,4 +3,4 @@ = Orchestrator process automation architecture [role="_abstract"] -TODO: Replace this placeholder with an overview of Orchestrator process automation architecture. +You can streamline and automate your work by using the Orchestrator in {product} to design, run, and monitor workflows across applications and services. diff --git a/titles/product_product/category-maps/develop/con-pre-built-workflow-container-image-capabilities.adoc b/titles/product_product/category-maps/develop/con-pre-built-workflow-container-image-capabilities.adoc index 8c889c4ea4..dc2a7adea7 100644 --- a/titles/product_product/category-maps/develop/con-pre-built-workflow-container-image-capabilities.adoc +++ b/titles/product_product/category-maps/develop/con-pre-built-workflow-container-image-capabilities.adoc @@ -3,4 +3,4 @@ = Pre-built workflow container image capabilities [role="_abstract"] -TODO: Replace this placeholder with an overview of Pre-built workflow container image capabilities. +Deploy a workflow and make it available in the Orchestrator plugin by building workflow images, generating workflow manifests, and deploying workflows to a cluster. diff --git a/titles/product_product/category-maps/develop/con-project-standardization-with-software-templates.adoc b/titles/product_product/category-maps/develop/con-project-standardization-with-software-templates.adoc index 6b2347b7ef..c927878628 100644 --- a/titles/product_product/category-maps/develop/con-project-standardization-with-software-templates.adoc +++ b/titles/product_product/category-maps/develop/con-project-standardization-with-software-templates.adoc @@ -3,4 +3,5 @@ = Project standardization with software templates [role="_abstract"] -TODO: Replace this placeholder with an overview of Project standardization with software templates. +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}. diff --git a/titles/product_product/category-maps/develop/con-register-and-update-software-components-to-maintain-a-unified-service-inventory.adoc b/titles/product_product/category-maps/develop/con-register-and-update-software-components-to-maintain-a-unified-service-inventory.adoc index 7ef1e7dc7c..04679489bc 100644 --- a/titles/product_product/category-maps/develop/con-register-and-update-software-components-to-maintain-a-unified-service-inventory.adoc +++ b/titles/product_product/category-maps/develop/con-register-and-update-software-components-to-maintain-a-unified-service-inventory.adoc @@ -3,4 +3,4 @@ = Register and update software components to maintain a unified service inventory [role="_abstract"] -TODO: Replace this placeholder with an overview of Register and update software components to maintain a unified service inventory. +The {product} Software Catalog is a centralized system that gives you visibility into all the software across your ecosystem, including services, websites, libraries, and data pipelines. diff --git a/titles/product_product/category-maps/develop/con-register-new-software-components.adoc b/titles/product_product/category-maps/develop/con-register-new-software-components.adoc index 80f13b46a0..64e9307f50 100644 --- a/titles/product_product/category-maps/develop/con-register-new-software-components.adoc +++ b/titles/product_product/category-maps/develop/con-register-new-software-components.adoc @@ -3,4 +3,4 @@ = Register new software components [role="_abstract"] -TODO: Replace this placeholder with an overview of Register new software components. +You can add new components to expand your {product-short} Software Catalog by registering them manually, creating them from Software Templates, or using bulk import. diff --git a/titles/product_product/category-maps/develop/con-register-repository-lists-with-the-orchestrator.adoc b/titles/product_product/category-maps/develop/con-register-repository-lists-with-the-orchestrator.adoc index f38beff966..6e1546eacb 100644 --- a/titles/product_product/category-maps/develop/con-register-repository-lists-with-the-orchestrator.adoc +++ b/titles/product_product/category-maps/develop/con-register-repository-lists-with-the-orchestrator.adoc @@ -3,4 +3,4 @@ = Register repository lists with the orchestrator [role="_abstract"] -TODO: Replace this placeholder with an overview of Register repository lists with the orchestrator. +Automate onboarding of GitHub repositories and GitLab projects to {product} catalog, and monitor import status by using bulk import capabilities. diff --git a/titles/product_product/category-maps/develop/con-standardized-project-generation-with-software-templates.adoc b/titles/product_product/category-maps/develop/con-standardized-project-generation-with-software-templates.adoc index 4c7d5f20de..a232f1c439 100644 --- a/titles/product_product/category-maps/develop/con-standardized-project-generation-with-software-templates.adoc +++ b/titles/product_product/category-maps/develop/con-standardized-project-generation-with-software-templates.adoc @@ -3,4 +3,6 @@ = Standardized project generation with software templates [role="_abstract"] -TODO: Replace this placeholder with an overview of Standardized project generation with software templates. +To standardize and accelerate the creation of new software, use Software Templates in {product} ({product-very-short}). + +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. diff --git a/titles/product_product/category-maps/develop/con-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc b/titles/product_product/category-maps/develop/con-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc index 67fc7dd9aa..cba6c00962 100644 --- a/titles/product_product/category-maps/develop/con-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc +++ b/titles/product_product/category-maps/develop/con-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc @@ -3,4 +3,8 @@ = Track component provenance to map dependencies back to source templates [role="_abstract"] -TODO: Replace this placeholder with an overview of Track component provenance to map dependencies back to source templates. +Track the dependency link between a generated entity and its source template to simplify lifecycle management. + +Platform engineers use custom actions within the Software Template scaffolding process to establish and track the dependency link between a generated entity (Component or Resource) and its source template. This relationship is called scaffolding provenance. + +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. diff --git a/titles/product_product/category-maps/develop/con-use-enabled-add-ons.adoc b/titles/product_product/category-maps/develop/con-use-enabled-add-ons.adoc index c776cdfea5..8b462fc0fe 100644 --- a/titles/product_product/category-maps/develop/con-use-enabled-add-ons.adoc +++ b/titles/product_product/category-maps/develop/con-use-enabled-add-ons.adoc @@ -3,4 +3,4 @@ = Use enabled add-ons [role="_abstract"] -TODO: Replace this placeholder with an overview of Use enabled add-ons. +After an administrator installs a TechDocs add-on in your {product} instance, you can use it to extend the functionality of the TechDocs plugin and enhance your documentation experience. diff --git a/titles/product_product/category-maps/develop/con-version-software-templates-to-track-template-updates-and-dependencies.adoc b/titles/product_product/category-maps/develop/con-version-software-templates-to-track-template-updates-and-dependencies.adoc index 514532ef8e..838ca93de5 100644 --- a/titles/product_product/category-maps/develop/con-version-software-templates-to-track-template-updates-and-dependencies.adoc +++ b/titles/product_product/category-maps/develop/con-version-software-templates-to-track-template-updates-and-dependencies.adoc @@ -3,4 +3,4 @@ = Version Software Templates to track template updates and dependencies [role="_abstract"] -TODO: Replace this placeholder with an overview of Version Software Templates to track template updates and dependencies. +Software Templates in {product} provide a streamlined way to create software components and publish them to different version control repositories such as Git. diff --git a/titles/product_product/category-maps/develop/con-workflow-design-best-practices.adoc b/titles/product_product/category-maps/develop/con-workflow-design-best-practices.adoc index 1f715cc138..304169ac85 100644 --- a/titles/product_product/category-maps/develop/con-workflow-design-best-practices.adoc +++ b/titles/product_product/category-maps/develop/con-workflow-design-best-practices.adoc @@ -3,4 +3,4 @@ = Workflow design best practices [role="_abstract"] -TODO: Replace this placeholder with an overview of Workflow design best practices. +Deploy a workflow and make it available in the Orchestrator plugin by building workflow images, generating workflow manifests, and deploying workflows to a cluster. diff --git a/titles/product_product/category-maps/develop/con-write-and-publish-documentation-as-code-to-keep-knowledge-synchronized.adoc b/titles/product_product/category-maps/develop/con-write-and-publish-documentation-as-code-to-keep-knowledge-synchronized.adoc index ccc2e4e7a2..e1dc688a80 100644 --- a/titles/product_product/category-maps/develop/con-write-and-publish-documentation-as-code-to-keep-knowledge-synchronized.adoc +++ b/titles/product_product/category-maps/develop/con-write-and-publish-documentation-as-code-to-keep-knowledge-synchronized.adoc @@ -3,4 +3,4 @@ = Write and publish documentation as code to keep knowledge synchronized [role="_abstract"] -TODO: Replace this placeholder with an overview of Write and publish documentation as code to keep knowledge synchronized. +After an administrator configures TechDocs, a developer can add documentation by importing from a remote repository, creating standalone docs, or enabling docs for an existing catalog entity. diff --git a/titles/product_product/category-maps/develop/nav-automate-template-lifecycle-management.adoc b/titles/product_product/category-maps/develop/nav-automate-template-lifecycle-management.adoc index 1dfadf1391..ee0706ca10 100644 --- a/titles/product_product/category-maps/develop/nav-automate-template-lifecycle-management.adoc +++ b/titles/product_product/category-maps/develop/nav-automate-template-lifecycle-management.adoc @@ -6,6 +6,6 @@ include::con-automate-template-lifecycle-management.adoc[leveloffset=+1] -// TODO: include Enable the scaffolder-relation-processor +include::modules/shared/proc-enable-the-scaffolder-relation-processor.adoc[leveloffset=+1] -// TODO: include Template sync limitations +include::modules/shared/ref-template-sync-limitations.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-automate-workflow-deployments.adoc b/titles/product_product/category-maps/develop/nav-automate-workflow-deployments.adoc index 863dd2ae7d..eda61e41d6 100644 --- a/titles/product_product/category-maps/develop/nav-automate-workflow-deployments.adoc +++ b/titles/product_product/category-maps/develop/nav-automate-workflow-deployments.adoc @@ -6,14 +6,16 @@ include::con-automate-workflow-deployments.adoc[leveloffset=+1] -// TODO: include Install Orchestrator Helm charts +include::modules/extend_orchestrator-in-rhdh/con-orchestrator-workflow-deployment-components.adoc[leveloffset=+1,navtitle="Workflow deployment components"] + +include::nav-install-orchestrator-helm-charts.adoc[leveloffset=+1] include::nav-install-orchestrator-in-an-air-gapped-environment.adoc[leveloffset=+1] -// TODO: include Launch workflow templates +include::modules/extend_orchestrator-in-rhdh/proc-create-a-serverless-workflow-project.adoc[leveloffset=+1,navtitle="Launch workflow templates"] -// TODO: include Apply generated GitOps resources +include::modules/extend_orchestrator-in-rhdh/proc-bootstrap-gitops-resources-and-trigger-pipelines.adoc[leveloffset=+1,navtitle="Apply generated GitOps resources"] -// TODO: include Verify your workflow deployment in the UI +include::modules/extend_orchestrator-in-rhdh/proc-verify-the-deployment.adoc[leveloffset=+1,navtitle="Verify your workflow deployment in the UI"] -// TODO: include Trigger workflows from event-driven systems +include::modules/extend_orchestrator-in-rhdh/ref-troubleshooting-workflow-deployments.adoc[leveloffset=+1,navtitle="Trigger workflows from event-driven systems"] diff --git a/titles/product_product/category-maps/develop/nav-build-serverless-workflows.adoc b/titles/product_product/category-maps/develop/nav-build-serverless-workflows.adoc index 6655e89897..9a80f92cc4 100644 --- a/titles/product_product/category-maps/develop/nav-build-serverless-workflows.adoc +++ b/titles/product_product/category-maps/develop/nav-build-serverless-workflows.adoc @@ -6,12 +6,12 @@ include::con-build-serverless-workflows.adoc[leveloffset=+1] -// TODO: include Pre-built workflow container image capabilities +include::nav-pre-built-workflow-container-image-capabilities.adoc[leveloffset=+1] -// TODO: include Build workflow container images locally using the build.sh script +include::nav-build-workflow-container-images-locally-using-the-build-sh-script.adoc[leveloffset=+1] -// TODO: include Review generated Kubernetes manifests +include::modules/extend_orchestrator-in-rhdh/con-generated-workflow-manifests.adoc[leveloffset=+1] -// TODO: include Deploy workflow images to an OpenShift cluster +include::modules/extend_orchestrator-in-rhdh/proc-deploy-workflows-on-a-cluster.adoc[leveloffset=+1] -// TODO: include Workflow design best practices +include::nav-workflow-design-best-practices.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-build-workflow-container-images-locally-using-the-build-sh-script.adoc b/titles/product_product/category-maps/develop/nav-build-workflow-container-images-locally-using-the-build-sh-script.adoc index 31e260c1ae..4720b5325c 100644 --- a/titles/product_product/category-maps/develop/nav-build-workflow-container-images-locally-using-the-build-sh-script.adoc +++ b/titles/product_product/category-maps/develop/nav-build-workflow-container-images-locally-using-the-build-sh-script.adoc @@ -5,3 +5,13 @@ :context: build-workflow-container-images-locally-using-the-build-sh-script include::con-build-workflow-container-images-locally-using-the-build-sh-script.adoc[leveloffset=+1] + +include::modules/extend_orchestrator-in-rhdh/proc-build-workflow-images-locally.adoc[leveloffset=+1,navtitle="build.sh script configuration and flags"] + +include::modules/extend_orchestrator-in-rhdh/con-the-build-sh-script-functionality-and-important-flags.adoc[leveloffset=+1,navtitle="Supported build environment variables"] + +include::modules/extend_orchestrator-in-rhdh/con-environment-variables-supported-by-the-build-script.adoc[leveloffset=+1,navtitle="Prerequisites"] + +include::modules/extend_orchestrator-in-rhdh/con-required-tools.adoc[leveloffset=+1,navtitle="Build a basic serverless workflow"] + +include::modules/extend_orchestrator-in-rhdh/proc-build-the-01-basic-workflow.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc b/titles/product_product/category-maps/develop/nav-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc index cd1cdf77fe..45ab009e3c 100644 --- a/titles/product_product/category-maps/develop/nav-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc +++ b/titles/product_product/category-maps/develop/nav-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc @@ -5,3 +5,13 @@ :context: configure-amazon-s3-or-openshift-data-foundation-buckets include::con-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc[leveloffset=+1] + +include::modules/configure_techdocs-for-rhdh/con-configuring-storage-for-techdocs-files.adoc[leveloffset=+1,navtitle="Configure Amazon S3"] + +include::modules/shared/proc-configure-amazon-s3-for-file-storage.adoc[leveloffset=+1,navtitle="Configure OpenShift Data Foundation"] + +include::modules/configure_techdocs-for-rhdh/proc-configure-for-file-storage.adoc[leveloffset=+1,navtitle="Configure object storage access with Operator"] + +include::modules/configure_techdocs-for-rhdh/proc-make-object-storage-accessible-to-containers-by-using-the-operator.adoc[leveloffset=+1,navtitle="Configure object storage access with Helm Chart"] + +include::modules/configure_techdocs-for-rhdh/proc-make-object-storage-accessible-to-containers-by-using-the-helm-chart.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-configure-bulk-import-capabilities.adoc b/titles/product_product/category-maps/develop/nav-configure-bulk-import-capabilities.adoc index 8e95b882ef..8ef3310761 100644 --- a/titles/product_product/category-maps/develop/nav-configure-bulk-import-capabilities.adoc +++ b/titles/product_product/category-maps/develop/nav-configure-bulk-import-capabilities.adoc @@ -6,10 +6,10 @@ include::con-configure-bulk-import-capabilities.adoc[leveloffset=+1] -// TODO: include Select and import Git projects +include::modules/shared/proc-manage-imported-repositories.adoc[leveloffset=+1,navtitle="Select and import Git projects"] -// TODO: include Review input parameters +include::modules/shared/con-review-input-parameters.adoc[leveloffset=+1] -// TODO: include Create custom Scaffolder workflows +include::modules/shared/proc-create-custom-scaffolder-workflows.adoc[leveloffset=+1] -// TODO: include Register repository lists with the orchestrator +include::nav-register-repository-lists-with-the-orchestrator.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-configure-techdocs-storage-and-cicd-pipelines.adoc b/titles/product_product/category-maps/develop/nav-configure-techdocs-storage-and-cicd-pipelines.adoc index 5dd235dbe1..b2d2b9403a 100644 --- a/titles/product_product/category-maps/develop/nav-configure-techdocs-storage-and-cicd-pipelines.adoc +++ b/titles/product_product/category-maps/develop/nav-configure-techdocs-storage-and-cicd-pipelines.adoc @@ -6,6 +6,6 @@ include::con-configure-techdocs-storage-and-cicd-pipelines.adoc[leveloffset=+1] -// TODO: include Configure Amazon S3 or OpenShift Data Foundation buckets +include::nav-configure-amazon-s3-or-openshift-data-foundation-buckets.adoc[leveloffset=+1] -// TODO: include Use the techdocs-cli in your CI/CD pipelines +include::modules/configure_techdocs-for-rhdh/con-configuring-ci-cd-to-generate-and-publish-techdocs-sites.adoc[leveloffset=+1,navtitle="Use the techdocs-cli in your CI/CD pipelines"] diff --git a/titles/product_product/category-maps/develop/nav-disable-or-remove-techdocs-add-ons.adoc b/titles/product_product/category-maps/develop/nav-disable-or-remove-techdocs-add-ons.adoc index 32c8fccc21..2a830073d2 100644 --- a/titles/product_product/category-maps/develop/nav-disable-or-remove-techdocs-add-ons.adoc +++ b/titles/product_product/category-maps/develop/nav-disable-or-remove-techdocs-add-ons.adoc @@ -5,3 +5,7 @@ :context: disable-or-remove-techdocs-add-ons include::con-disable-or-remove-techdocs-add-ons.adoc[leveloffset=+1] + +include::modules/shared/proc-remove-an-external-techdocs-add-on-from-your-configmap.adoc[leveloffset=+1,navtitle="Remove from your Operator"] + +include::modules/shared/proc-remove-an-external-techdocs-add-on-from-your-helm-chart.adoc[leveloffset=+1,navtitle="Remove from your Helm Chart"] diff --git a/titles/product_product/category-maps/develop/nav-import-source-code-repositories-in-bulk.adoc b/titles/product_product/category-maps/develop/nav-import-source-code-repositories-in-bulk.adoc index 68d6a3809f..0fc43aa027 100644 --- a/titles/product_product/category-maps/develop/nav-import-source-code-repositories-in-bulk.adoc +++ b/titles/product_product/category-maps/develop/nav-import-source-code-repositories-in-bulk.adoc @@ -6,10 +6,12 @@ include::con-import-source-code-repositories-in-bulk.adoc[leveloffset=+1] -// TODO: include Enable and authorize bulk import plugins +include::modules/shared/con-repository-visibility-in-bulk-import.adoc[leveloffset=+1] -// TODO: include Select and import GitHub repositories +include::modules/shared/proc-enable-and-authorize-bulk-import-plugins.adoc[leveloffset=+1] -// TODO: include Manage imported repositories +include::modules/shared/proc-select-and-import-github-repositories.adoc[leveloffset=+1] -// TODO: include Monitor bulk import operations in audit logs +include::modules/shared/proc-manage-imported-repositories.adoc[leveloffset=+1,navtitle="Manage imported repositories"] + +include::modules/shared/proc-monitor-bulk-import-operations-in-audit-logs.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-install-external-or-third-party-add-ons.adoc b/titles/product_product/category-maps/develop/nav-install-external-or-third-party-add-ons.adoc index 7e8dafb274..73c62450cc 100644 --- a/titles/product_product/category-maps/develop/nav-install-external-or-third-party-add-ons.adoc +++ b/titles/product_product/category-maps/develop/nav-install-external-or-third-party-add-ons.adoc @@ -5,3 +5,7 @@ :context: install-external-or-third-party-add-ons include::con-install-external-or-third-party-add-ons.adoc[leveloffset=+1] + +include::modules/shared/proc-install-and-configure-an-external-techdocs-add-on-using-the-operator.adoc[leveloffset=+1,navtitle="Install with Operator"] + +include::modules/shared/proc-install-and-configure-an-external-techdocs-add-on-using-the-helm-chart.adoc[leveloffset=+1,navtitle="Install with Helm Chart"] diff --git a/titles/product_product/category-maps/develop/nav-install-orchestrator-helm-charts.adoc b/titles/product_product/category-maps/develop/nav-install-orchestrator-helm-charts.adoc index 48b2a8f4a6..9f54fd7bbc 100644 --- a/titles/product_product/category-maps/develop/nav-install-orchestrator-helm-charts.adoc +++ b/titles/product_product/category-maps/develop/nav-install-orchestrator-helm-charts.adoc @@ -5,3 +5,9 @@ :context: install-orchestrator-helm-charts include::con-install-orchestrator-helm-charts.adoc[leveloffset=+1] + +include::modules/extend_orchestrator-in-rhdh/proc-install-orchestrator-software-templates.adoc[leveloffset=+1,navtitle="Install the Infra chart"] + +include::modules/extend_orchestrator-in-rhdh/proc-install-the-orchestrator-software-templates-infra-chart.adoc[leveloffset=+1,navtitle="Enable workflow software templates"] + +include::modules/extend_orchestrator-in-rhdh/proc-install-the-orchestrator-software-templates-chart.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-install-orchestrator-in-an-air-gapped-environment.adoc b/titles/product_product/category-maps/develop/nav-install-orchestrator-in-an-air-gapped-environment.adoc index ed4f17d969..ccdbc579ac 100644 --- a/titles/product_product/category-maps/develop/nav-install-orchestrator-in-an-air-gapped-environment.adoc +++ b/titles/product_product/category-maps/develop/nav-install-orchestrator-in-an-air-gapped-environment.adoc @@ -6,6 +6,10 @@ include::con-install-orchestrator-in-an-air-gapped-environment.adoc[leveloffset=+1] -// TODO: include Install Orchestrator with the Operator +include::modules/extend_orchestrator-in-rhdh/proc-install-rhdh-with-orchestrator-in-a-fully-disconnected-ocp-environment-using-the-operator.adoc[leveloffset=+1,navtitle="Install Orchestrator with the Operator"] -// TODO: include Install Orchestrator with the Helm chart +include::modules/extend_orchestrator-in-rhdh/proc-install-rhdh-with-orchestrator-in-a-partially-disconnected-ocp-environment-using-the-operator.adoc[leveloffset=+1] + +include::modules/extend_orchestrator-in-rhdh/proc-install-rhdh-with-orchestrator-in-a-fully-disconnected-ocp-environment-using-the-helm-chart.adoc[leveloffset=+1,navtitle="Install Orchestrator with the Helm chart"] + +include::modules/extend_orchestrator-in-rhdh/proc-install-rhdh-with-orchestrator-in-a-partially-disconnected-ocp-environment-using-the-helm-chart.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-install-techdocs-add-ons.adoc b/titles/product_product/category-maps/develop/nav-install-techdocs-add-ons.adoc index b70aa186ec..6cfd2d84e1 100644 --- a/titles/product_product/category-maps/develop/nav-install-techdocs-add-ons.adoc +++ b/titles/product_product/category-maps/develop/nav-install-techdocs-add-ons.adoc @@ -6,8 +6,8 @@ include::con-install-techdocs-add-ons.adoc[leveloffset=+1] -// TODO: include Install external or third-party add-ons +include::nav-install-external-or-third-party-add-ons.adoc[leveloffset=+1] -// TODO: include Disable or remove TechDocs add-ons +include::nav-disable-or-remove-techdocs-add-ons.adoc[leveloffset=+1] -// TODO: include Use enabled add-ons +include::nav-use-enabled-add-ons.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-manage-your-software-components.adoc b/titles/product_product/category-maps/develop/nav-manage-your-software-components.adoc index ee581c2733..60c168599d 100644 --- a/titles/product_product/category-maps/develop/nav-manage-your-software-components.adoc +++ b/titles/product_product/category-maps/develop/nav-manage-your-software-components.adoc @@ -6,14 +6,14 @@ include::con-manage-your-software-components.adoc[leveloffset=+1] -// TODO: include Register new software components +include::nav-register-new-software-components.adoc[leveloffset=+1] -// TODO: include Update component YAML metadata +include::modules/shared/proc-update-component-yaml-metadata.adoc[leveloffset=+1] -// TODO: include Filter the catalog by entity kind +include::modules/shared/proc-filter-the-catalog-by-entity-kind.adoc[leveloffset=+1] -// TODO: include Search the catalog using text filters +include::modules/shared/proc-search-the-catalog-using-text-filters.adoc[leveloffset=+1] -// TODO: include Review the raw YAML configuration +include::modules/shared/proc-review-the-raw-yaml-configuration.adoc[leveloffset=+1] -// TODO: include Star frequently used components +include::modules/shared/proc-star-frequently-used-components.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-orchestrate-infrastructure-tasks-using-workflows.adoc b/titles/product_product/category-maps/develop/nav-orchestrate-infrastructure-tasks-using-workflows.adoc index 8a17fa5b78..4fa9c04c0f 100644 --- a/titles/product_product/category-maps/develop/nav-orchestrate-infrastructure-tasks-using-workflows.adoc +++ b/titles/product_product/category-maps/develop/nav-orchestrate-infrastructure-tasks-using-workflows.adoc @@ -6,7 +6,7 @@ include::con-orchestrate-infrastructure-tasks-using-workflows.adoc[leveloffset=+1] -// TODO: include Orchestrator process automation architecture +include::nav-orchestrator-process-automation-architecture.adoc[leveloffset=+1] include::nav-build-serverless-workflows.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-orchestrator-process-automation-architecture.adoc b/titles/product_product/category-maps/develop/nav-orchestrator-process-automation-architecture.adoc index 33ed8a131f..1ed4407efa 100644 --- a/titles/product_product/category-maps/develop/nav-orchestrator-process-automation-architecture.adoc +++ b/titles/product_product/category-maps/develop/nav-orchestrator-process-automation-architecture.adoc @@ -5,3 +5,7 @@ :context: orchestrator-process-automation-architecture include::con-orchestrator-process-automation-architecture.adoc[leveloffset=+1] + +include::modules/extend_orchestrator-in-rhdh/ref-compatibility-guide-for-orchestrator.adoc[leveloffset=+1] + +include::modules/extend_orchestrator-in-rhdh/con-understand-orchestrator-architecture.adoc[leveloffset=+1,navtitle="Operator and orchestrator plugin compatibility matrix"] diff --git a/titles/product_product/category-maps/develop/nav-pre-built-workflow-container-image-capabilities.adoc b/titles/product_product/category-maps/develop/nav-pre-built-workflow-container-image-capabilities.adoc index 7a23b594cf..600b32b80c 100644 --- a/titles/product_product/category-maps/develop/nav-pre-built-workflow-container-image-capabilities.adoc +++ b/titles/product_product/category-maps/develop/nav-pre-built-workflow-container-image-capabilities.adoc @@ -5,3 +5,9 @@ :context: pre-built-workflow-container-image-capabilities include::con-pre-built-workflow-container-image-capabilities.adoc[leveloffset=+1] + +include::modules/extend_orchestrator-in-rhdh/con-benefits-of-workflow-images.adoc[leveloffset=+1,navtitle="Project structure"] + +include::modules/extend_orchestrator-in-rhdh/con-project-structure-overview.adoc[leveloffset=+1,navtitle="Develop and test serverless workflows locally"] + +include::modules/extend_orchestrator-in-rhdh/proc-create-and-run-your-serverless-workflow-project-locally.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-project-standardization-with-software-templates.adoc b/titles/product_product/category-maps/develop/nav-project-standardization-with-software-templates.adoc index e465e803c7..a51170a22e 100644 --- a/titles/product_product/category-maps/develop/nav-project-standardization-with-software-templates.adoc +++ b/titles/product_product/category-maps/develop/nav-project-standardization-with-software-templates.adoc @@ -6,15 +6,15 @@ include::con-project-standardization-with-software-templates.adoc[leveloffset=+1] -// TODO: include Create new Software Templates +include::modules/shared/proc-create-new-software-templates.adoc[leveloffset=+1] -// TODO: include Use sample templates +include::modules/shared/ref-use-sample-templates.adoc[leveloffset=+1] -// TODO: include Publish template definitions to the catalog +include::modules/shared/proc-publish-template-definitions-to-the-catalog.adoc[leveloffset=+1] -// TODO: include Extend templates using conditional logic and external fetch capabilities +include::modules/shared/ref-extend-templates-using-conditional-logic-and-external-fetch-capabilities.adoc[leveloffset=+1] -// TODO: include Version Software Templates to track template updates and dependencies +include::nav-version-software-templates-to-track-template-updates-and-dependencies.adoc[leveloffset=+1] include::nav-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-register-new-software-components.adoc b/titles/product_product/category-maps/develop/nav-register-new-software-components.adoc index 9241e2dff6..b69ccf13dd 100644 --- a/titles/product_product/category-maps/develop/nav-register-new-software-components.adoc +++ b/titles/product_product/category-maps/develop/nav-register-new-software-components.adoc @@ -5,3 +5,7 @@ :context: register-new-software-components include::con-register-new-software-components.adoc[leveloffset=+1] + +include::modules/shared/proc-generate-new-components.adoc[leveloffset=+1] + +include::modules/shared/proc-register-existing-repositories-manually.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-register-repository-lists-with-the-orchestrator.adoc b/titles/product_product/category-maps/develop/nav-register-repository-lists-with-the-orchestrator.adoc index a7a93d1eee..dfb6a1fc31 100644 --- a/titles/product_product/category-maps/develop/nav-register-repository-lists-with-the-orchestrator.adoc +++ b/titles/product_product/category-maps/develop/nav-register-repository-lists-with-the-orchestrator.adoc @@ -5,3 +5,7 @@ :context: register-repository-lists-with-the-orchestrator include::con-register-repository-lists-with-the-orchestrator.adoc[leveloffset=+1] + +include::modules/shared/proc-run-orchestrator-workflows-for-bulk-imports.adoc[leveloffset=+1] + +include::modules/shared/con-data-handoff-and-custom-workflow-design.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-standardized-project-generation-with-software-templates.adoc b/titles/product_product/category-maps/develop/nav-standardized-project-generation-with-software-templates.adoc index 03b3152ced..a383df5fbb 100644 --- a/titles/product_product/category-maps/develop/nav-standardized-project-generation-with-software-templates.adoc +++ b/titles/product_product/category-maps/develop/nav-standardized-project-generation-with-software-templates.adoc @@ -6,8 +6,8 @@ include::con-standardized-project-generation-with-software-templates.adoc[leveloffset=+1] -// TODO: include Run Software Templates from the UI +include::modules/shared/proc-run-software-templates-from-the-ui.adoc[leveloffset=+1] -// TODO: include Browse available templates +include::modules/shared/proc-browse-available-templates.adoc[leveloffset=+1] -// TODO: include Import an existing template file using the Catalog Processor +include::modules/shared/proc-import-an-existing-template-file-using-the-catalog-processor.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc b/titles/product_product/category-maps/develop/nav-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc index 2e29e27447..f1a0d9f418 100644 --- a/titles/product_product/category-maps/develop/nav-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc +++ b/titles/product_product/category-maps/develop/nav-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc @@ -6,6 +6,6 @@ include::con-track-component-provenance-to-map-dependencies-back-to-source-templates.adoc[leveloffset=+1] -// TODO: include Configure provenance annotations +include::modules/shared/proc-configure-provenance-annotations.adoc[leveloffset=+1] -// TODO: include View template dependencies in the catalog +include::modules/shared/proc-view-template-dependencies-in-the-catalog.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-use-enabled-add-ons.adoc b/titles/product_product/category-maps/develop/nav-use-enabled-add-ons.adoc index b466bbd928..1e4b4d5b63 100644 --- a/titles/product_product/category-maps/develop/nav-use-enabled-add-ons.adoc +++ b/titles/product_product/category-maps/develop/nav-use-enabled-add-ons.adoc @@ -5,3 +5,9 @@ :context: use-enabled-add-ons include::con-use-enabled-add-ons.adoc[leveloffset=+1] + +include::modules/shared/proc-use-the-reportissue-techdocs-add-on.adoc[leveloffset=+1,navtitle="Configure documentation issue reporting"] + +include::modules/shared/proc-use-the-textsize-techdocs-add-on.adoc[leveloffset=+1,navtitle="Configure documentation text scaling"] + +include::modules/shared/proc-use-the-lightbox-techdocs-add-on.adoc[leveloffset=+1,navtitle="Configure image overlay features"] diff --git a/titles/product_product/category-maps/develop/nav-version-software-templates-to-track-template-updates-and-dependencies.adoc b/titles/product_product/category-maps/develop/nav-version-software-templates-to-track-template-updates-and-dependencies.adoc index d103476212..1cd2c0b88e 100644 --- a/titles/product_product/category-maps/develop/nav-version-software-templates-to-track-template-updates-and-dependencies.adoc +++ b/titles/product_product/category-maps/develop/nav-version-software-templates-to-track-template-updates-and-dependencies.adoc @@ -5,3 +5,7 @@ :context: version-software-templates-to-track-template-updates-and-dependencies include::con-version-software-templates-to-track-template-updates-and-dependencies.adoc[leveloffset=+1] + +include::modules/shared/proc-version-software-templates.adoc[leveloffset=+1] + +include::modules/shared/proc-enable-update-notifications.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-workflow-design-best-practices.adoc b/titles/product_product/category-maps/develop/nav-workflow-design-best-practices.adoc index 5ed0376305..55eaef850e 100644 --- a/titles/product_product/category-maps/develop/nav-workflow-design-best-practices.adoc +++ b/titles/product_product/category-maps/develop/nav-workflow-design-best-practices.adoc @@ -5,3 +5,7 @@ :context: workflow-design-best-practices include::con-workflow-design-best-practices.adoc[leveloffset=+1] + +include::modules/extend_orchestrator-in-rhdh/ref-best-practices-when-creating-serverless-workflows.adoc[leveloffset=+1,navtitle="Unique workflow ID requirements"] + +include::modules/extend_orchestrator-in-rhdh/ref-unique-workflow-id-requirements-to-prevent-duplicates.adoc[leveloffset=+1] diff --git a/titles/product_product/category-maps/develop/nav-write-and-publish-documentation-as-code-to-keep-knowledge-synchronized.adoc b/titles/product_product/category-maps/develop/nav-write-and-publish-documentation-as-code-to-keep-knowledge-synchronized.adoc index 855b2d7abd..3698babdc5 100644 --- a/titles/product_product/category-maps/develop/nav-write-and-publish-documentation-as-code-to-keep-knowledge-synchronized.adoc +++ b/titles/product_product/category-maps/develop/nav-write-and-publish-documentation-as-code-to-keep-knowledge-synchronized.adoc @@ -8,15 +8,15 @@ include::con-write-and-publish-documentation-as-code-to-keep-knowledge-synchroni // TODO: include Docs-like-code practices for TechDocs strategies -// TODO: include Import Markdown documentation +include::modules/shared/proc-import-documentation-into-techdocs-from-a-remote-repository.adoc[leveloffset=+1,navtitle="Import Markdown documentation"] -// TODO: include Filter the TechDocs catalog +include::modules/shared/proc-search-for-relevant-content.adoc[leveloffset=+1,navtitle="Filter the TechDocs catalog"] -// TODO: include Navigate within TechDocs books +include::modules/shared/proc-access-and-navigate-documentation.adoc[leveloffset=+1,navtitle="Navigate within TechDocs books"] -// TODO: include Edit TechDocs files directly +include::modules/shared/proc-make-changes-to-project-documentation-in-techdocs.adoc[leveloffset=+1,navtitle="Edit TechDocs files directly"] -// TODO: include Embed video iframes +include::modules/shared/proc-add-video-content-to-enhance-techdocs.adoc[leveloffset=+1,navtitle="Embed video iframes"] include::nav-configure-techdocs-storage-and-cicd-pipelines.adoc[leveloffset=+1] @@ -24,4 +24,4 @@ include::nav-configure-techdocs-storage-and-cicd-pipelines.adoc[leveloffset=+1] include::nav-install-techdocs-add-ons.adoc[leveloffset=+1] -// TODO: include Develop custom TechDocs add-ons as React components +include::modules/shared/proc-create-a-techdocs-add-on.adoc[leveloffset=+1,navtitle="Develop custom TechDocs add-ons as React components"]