diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index 9459bdefe2..44bfde0385 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -7,14 +7,6 @@ include::{docdir}/artifacts/snip-technology-preview.adoc[] {product} can automate GitHub repositories onboarding and track their import status. -include::modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc[leveloffset=+1] - -include::modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc[leveloffset=+1] - -include::modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc[leveloffset=+1] - -include::modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc[leveloffset=+1] - include::modules/importing-repositories/concept-bulk-import-scaffolder-template.adoc[leveloffset=+1] include::modules/importing-repositories/procedure-integrating-bulk-import-with-orchestrator-workflows.adoc[leveloffset=+1] diff --git a/assemblies/assembly-about-software-catalogs.adoc b/assemblies/assembly-centralizing-your-software-components-in-rhdh.adoc similarity index 52% rename from assemblies/assembly-about-software-catalogs.adoc rename to assemblies/assembly-centralizing-your-software-components-in-rhdh.adoc index eb523b2668..f6ccf48972 100644 --- a/assemblies/assembly-about-software-catalogs.adoc +++ b/assemblies/assembly-centralizing-your-software-components-in-rhdh.adoc @@ -1,8 +1,8 @@ :_mod-docs-content-type: ASSEMBLY -:context: about-software-catalogs +:context: centralizing-your-software-components-in-rhdh [id="{context}"] -= About Software Catalogs += Centralizing your software components in the {product} catalog for easier access 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. You can use it to view ownership details and metadata for each component in one place. @@ -16,18 +16,18 @@ The *Overview* page for a component provides key information such as links to th //[Add any Component screenshot of the latest build] -include::modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc[leveloffset=+1] +include::modules/centralizing-your-software-components-in-rhdh/proc-adding-new-components-to-the-rhdh-instance.adoc[leveloffset=+1] -include::modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc[leveloffset=+2] +include::modules/centralizing-your-software-components-in-rhdh/proc-creating-new-components-in-the-rhdh-instance.adoc[leveloffset=+2] -include::modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc[leveloffset=+2] +include::modules/centralizing-your-software-components-in-rhdh/proc-registering-components-manually-in-the-rhdh-instance.adoc[leveloffset=+2] -include::modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc[leveloffset=+1] +include::modules/centralizing-your-software-components-in-rhdh/proc-updating-existing-components-in-your-rhdh-catalog.adoc[leveloffset=+1] -include::modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-kind.adoc[leveloffset=+1] +include::modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-kind.adoc[leveloffset=+1] -include::modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-using-the-filter-field.adoc[leveloffset=+1] +include::modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-using-the-filter-field.adoc[leveloffset=+1] -include::modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc[leveloffset=+1] +include::modules/centralizing-your-software-components-in-rhdh/proc-reviewing-the-yaml-configuration-of-your-rhdh-software-catalog.adoc[leveloffset=+1] -include::modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc[leveloffset=+1] +include::modules/centralizing-your-software-components-in-rhdh/proc-starring-key-components-in-the-software-catalog.adoc[leveloffset=+1] diff --git a/assemblies/assembly-configuring-templates.adoc b/assemblies/assembly-configuring-templates.adoc index 0c3c4440f7..e8a493dc3a 100644 --- a/assemblies/assembly-configuring-templates.adoc +++ b/assemblies/assembly-configuring-templates.adoc @@ -7,17 +7,6 @@ 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}. -You can configure Software Templates to create software components, and publish these components to Git repositories. -Once the components are published to Git repositories, register these components in the Software Catalog. - -A template is a form composed of different UI fields that is defined in a YAML file. -Software Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally. - -include::modules/customizing-templates/proc-creating-templates.adoc[leveloffset=+1] -include::modules/customizing-templates/ref-creating-templates.adoc[leveloffset=+1] -include::modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc[leveloffset=+1] -include::modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc[leveloffset=+1] -include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1] include::modules/customizing-templates/proc-versioning-software-templates.adoc[leveloffset=+1] include::modules/customizing-templates/proc-enabling-software-template-version-update-notifications.adoc[leveloffset=+1] include::assembly-tracking-component-origin-and-software-template-version.adoc[leveloffset=+1] diff --git a/assemblies/assembly-importing-and-using-an-existing-template-for-faster-development.adoc b/assemblies/assembly-importing-and-using-an-existing-template-for-faster-development.adoc new file mode 100644 index 0000000000..6d4d1b8adc --- /dev/null +++ b/assemblies/assembly-importing-and-using-an-existing-template-for-faster-development.adoc @@ -0,0 +1,21 @@ +:_mod-docs-content-type: ASSEMBLY +:context: importing-and-using-an-existing-template-for-faster-development + +[id="{context}"] += Importing and using an existing Software Template for faster development + +You can configure Software Templates to create software components and publish these components to Git repositories. +Once the components are published to Git repositories, register these components in the Software Catalog. + +A template is a form composed of different UI fields that is defined in a YAML file. +Software Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally. + +include::modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-templates.adoc[leveloffset=+1] + +include::modules/importing-and-using-an-existing-template-for-faster-development/ref-creating-templates.adoc[leveloffset=+1] + +include::modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-new-software-component-using-templates.adoc[leveloffset=+1] + +include::modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc[leveloffset=+1] + +include::modules/importing-and-using-an-existing-template-for-faster-development/proc-adding-templates.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-importing-your-team-codebase-from-git.adoc b/assemblies/assembly-importing-your-team-codebase-from-git.adoc new file mode 100644 index 0000000000..1ea6504ea8 --- /dev/null +++ b/assemblies/assembly-importing-your-team-codebase-from-git.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: ASSEMBLY + +[id="importing-your-team-codebase-from-git"] += Importing your team's codebase from Git + +include::{docdir}/artifacts/snip-technology-preview.adoc[] + +{product} can automate GitHub repositories onboarding and track their import status. + +include::modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc[leveloffset=+1] + +include::modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc[leveloffset=+1] + +include::modules/streamline-software-development-and-management/proc-managing-repositories-after-import-to-stay-organized.adoc[leveloffset=+1] + +include::modules/streamline-software-development-and-management/proc-monitoring-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-manage-and-consume-techdoc-within-rhdh.adoc b/assemblies/assembly-manage-and-consume-techdoc-within-rhdh.adoc new file mode 100644 index 0000000000..85d8a7e24e --- /dev/null +++ b/assemblies/assembly-manage-and-consume-techdoc-within-rhdh.adoc @@ -0,0 +1,21 @@ +:_mod-docs-content-type: ASSEMBLY +:context: assembly-manage-and-consume-techdoc-within-rhdh + +[id="{context}"] += Manage and consume technical documentation within {product} + +The TechDocs plugin is installed and enabled on your {product} instance by default. After an administrator configures the TechDocs plugin, an authorized developer can use the TechDocs plugin to add, view, or manage documentation. + +include::assembly-techdocs-add-docs.adoc[leveloffset=+1] + +include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-find-docs.adoc[leveloffset=+1] + +include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-view-docs.adoc[leveloffset=+1] + +include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-edit-docs.adoc[leveloffset=+1] + +//embedding videos +include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-embed-videos.adoc[leveloffset=+1] + +//generating pipelines with GitHub Actions +include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-pipeline-github-actions.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-techdocs-add-docs.adoc b/assemblies/assembly-techdocs-add-docs.adoc index 636a204f13..0668ac0008 100644 --- a/assemblies/assembly-techdocs-add-docs.adoc +++ b/assemblies/assembly-techdocs-add-docs.adoc @@ -2,7 +2,7 @@ :context: assembly-techdocs-add-docs [id="{context}"] -= Adding documentation to TechDocs += Adding documentation to TechDocs for your project After an administrator configures the TechDocs plugin, a developer can add documentation to TechDocs by importing it from a remote repository. Any authorized user or group can access the documentation that is imported into the TechDocs plugin. diff --git a/assemblies/assembly-using-techdocs.adoc b/assemblies/assembly-using-techdocs.adoc deleted file mode 100644 index 14ac67075d..0000000000 --- a/assemblies/assembly-using-techdocs.adoc +++ /dev/null @@ -1,21 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -:context: assembly-using-techdocs - -[id="{context}"] -= Using TechDocs - -The TechDocs plugin is installed and enabled on your {product} instance by default. After an administrator configures the TechDocs plugin, an authorized developer can use the TechDocs plugin to add, view, or manage documentation. - -include::assembly-techdocs-add-docs.adoc[leveloffset=+1] - -include::modules/techdocs/proc-techdocs-find-docs.adoc[leveloffset=+1] - -include::modules/techdocs/proc-techdocs-view-docs.adoc[leveloffset=+1] - -include::modules/techdocs/proc-techdocs-edit-docs.adoc[leveloffset=+1] - -//embedding videos -include::modules/techdocs/proc-techdocs-embed-videos.adoc[leveloffset=+1] - -//generating pipelines with GitHub Actions -include::modules/techdocs/proc-techdocs-pipeline-github-actions.adoc[leveloffset=+1] diff --git a/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc b/modules/centralizing-your-software-components-in-rhdh/proc-adding-new-components-to-the-rhdh-instance.adoc similarity index 90% rename from modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc rename to modules/centralizing-your-software-components-in-rhdh/proc-adding-new-components-to-the-rhdh-instance.adoc index 8ad60e67ae..b4bb347539 100644 --- a/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc +++ b/modules/centralizing-your-software-components-in-rhdh/proc-adding-new-components-to-the-rhdh-instance.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-adding-new-components-to-the-rhdh-instance_{context}"] -= Adding new components to your {product} instance += Adding new components to your {product} instance to expand your catalog .Prerequisites diff --git a/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc b/modules/centralizing-your-software-components-in-rhdh/proc-creating-new-components-in-the-rhdh-instance.adoc similarity index 100% rename from modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc rename to modules/centralizing-your-software-components-in-rhdh/proc-creating-new-components-in-the-rhdh-instance.adoc diff --git a/modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-kind.adoc b/modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-kind.adoc similarity index 68% rename from modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-kind.adoc rename to modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-kind.adoc index 83b2d56d61..4fd7abd4a4 100644 --- a/modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-kind.adoc +++ b/modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-kind.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-searching-and-filtering-software-catalog-items-by-kind_{context}"] -= Searching and Filtering Software Catalogs by Kind +[id="proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-kind_{context}"] += Finding the right components quickly in the {product} catalog by Kind .Procedure diff --git a/modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-using-the-filter-field.adoc b/modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-using-the-filter-field.adoc similarity index 59% rename from modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-using-the-filter-field.adoc rename to modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-using-the-filter-field.adoc index b5f0f3beb0..1d5f03b111 100644 --- a/modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-using-the-filter-field.adoc +++ b/modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-using-the-filter-field.adoc @@ -2,8 +2,8 @@ // // * assemblies/assembly-about-software-catalogs.adoc :_mod-docs-content-type: PROCEDURE -[id="proc-searching-and-filtering-software-catalog-items-by-using-the-filter-field_{context}"] -= Searching and Filtering Software Catalog items by using the Filter field +[id="proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-using-the-filter-field_{context}"] += Finding the right component quickly in the {product} catalog by using the Filter field .Procedure diff --git a/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc b/modules/centralizing-your-software-components-in-rhdh/proc-registering-components-manually-in-the-rhdh-instance.adoc similarity index 100% rename from modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc rename to modules/centralizing-your-software-components-in-rhdh/proc-registering-components-manually-in-the-rhdh-instance.adoc diff --git a/modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc b/modules/centralizing-your-software-components-in-rhdh/proc-reviewing-the-yaml-configuration-of-your-rhdh-software-catalog.adoc similarity index 77% rename from modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc rename to modules/centralizing-your-software-components-in-rhdh/proc-reviewing-the-yaml-configuration-of-your-rhdh-software-catalog.adoc index 1e2fac516e..e0dd720bef 100644 --- a/modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc +++ b/modules/centralizing-your-software-components-in-rhdh/proc-reviewing-the-yaml-configuration-of-your-rhdh-software-catalog.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-viewing-software-catalog-yaml_{context}"] -= Viewing the Software Catalog YAML file in your {product} instance +[id="proc-reviewing-the-yaml-configuration-of-your-rhdh-software-catalog_{context}"] += Reviewing the YAML configuration of your {product} Software Catalog You can view the Software Catalog YAML file in your {product} instance. The YAML file displays the metadata for the components in your Software Catalog. diff --git a/modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc b/modules/centralizing-your-software-components-in-rhdh/proc-starring-key-components-in-the-software-catalog.adoc similarity index 81% rename from modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc rename to modules/centralizing-your-software-components-in-rhdh/proc-starring-key-components-in-the-software-catalog.adoc index b09d242145..85e2a21a29 100644 --- a/modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc +++ b/modules/centralizing-your-software-components-in-rhdh/proc-starring-key-components-in-the-software-catalog.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-starring-components-in-the-software-catalog_{context}"] -= Starring components in the Software Catalog +[id="proc-starring-key-components-in-the-software-catalog_{context}"] += Starring key components in the Software Catalog You can use the *Add to favorites* icon to add the software catalogs that you visit regularly to the *Starred* category. diff --git a/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc b/modules/centralizing-your-software-components-in-rhdh/proc-updating-existing-components-in-your-rhdh-catalog.adoc similarity index 85% rename from modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc rename to modules/centralizing-your-software-components-in-rhdh/proc-updating-existing-components-in-your-rhdh-catalog.adoc index 03e219c0a6..9091171de3 100644 --- a/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc +++ b/modules/centralizing-your-software-components-in-rhdh/proc-updating-existing-components-in-your-rhdh-catalog.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-updating-components-in-the-software-catalog_{context}"] -= Updating components in the Software Catalog in your {product} instance +[id="proc-updating-existing-components-in-your-rhdh-catalog_{context}"] += Updating existing component in your {product} catalog You can update components in the Software Catalog in your {product} instance. diff --git a/modules/customizing-templates/proc-adding-templates.adoc b/modules/importing-and-using-an-existing-template-for-faster-development/proc-adding-templates.adoc similarity index 100% rename from modules/customizing-templates/proc-adding-templates.adoc rename to modules/importing-and-using-an-existing-template-for-faster-development/proc-adding-templates.adoc diff --git a/modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc b/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-new-software-component-using-templates.adoc similarity index 100% rename from modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc rename to modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-new-software-component-using-templates.adoc diff --git a/modules/customizing-templates/proc-creating-templates.adoc b/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-templates.adoc similarity index 100% rename from modules/customizing-templates/proc-creating-templates.adoc rename to modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-templates.adoc diff --git a/modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc b/modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc similarity index 100% rename from modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc rename to modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc diff --git a/modules/importing-and-using-an-existing-template-for-faster-development/ref-creating-templates.adoc b/modules/importing-and-using-an-existing-template-for-faster-development/ref-creating-templates.adoc new file mode 100644 index 0000000000..7c89406b1b --- /dev/null +++ b/modules/importing-and-using-an-existing-template-for-faster-development/ref-creating-templates.adoc @@ -0,0 +1,73 @@ +:_mod-docs-content-type: REFERENCE + +[id="ref-creating-templates_{context}"] += Creating a Software Template as a YAML file + +You can create a Software Template by defining a `Template` object as a YAML file. + +The `Template` object describes the Software Template and its metadata. It also contains required input variables and a list of actions that are executed by the scaffolding service. + +.`Template` object example +[source,yaml] +---- +apiVersion: scaffolder.backstage.io/v1beta3 +kind: Template +metadata: + name: template-name # <1> + title: Example template # <2> + description: An example template for v1beta3 scaffolder. # <3> +spec: + owner: backstage/techdocs-core # <4> + type: service # <5> + parameters: # <6> + - title: Fill in some steps + required: + - name + properties: + name: + title: Name + type: string + description: Unique name of the component + owner: + title: Owner + type: string + description: Owner of the component + - title: Choose a location + required: + - repoUrl + properties: + repoUrl: + title: Repository Location + type: string + steps: # <7> + - id: fetch-base + name: Fetch Base + action: fetch:template + # ... + output: # <8> + links: + - title: Repository # <9> + url: ${{ steps['publish'].output.remoteUrl }} + - title: Open in catalog # <10> + icon: catalog + entityRef: ${{ steps['register'].output.entityRef }} +# ... +---- +<1> Specify a name for the Software Template. +<2> Specify a title for the Software Template. This is the title that is visible on the Software Template tile in the *Self-service* view. +<3> Specify a description for the Software Template. This is the description that is visible on the Software Template tile in the *Self-service* view. +<4> Specify the ownership of the Software Template. The `owner` field provides information about who is responsible for maintaining or overseeing the Software Template within the system or organization. In the provided example, the `owner` field is set to `backstage/techdocs-core`. This means that this Software Template belongs to the `techdocs-core` project in the `backstage` namespace. +<5> Specify the component type. Any string value is accepted for this required field, but your organization should establish a proper taxonomy for these. {product} instances may read this field and behave differently depending on its value. For example, a `website` type component may present tooling in the {product} interface that is specific to just websites. ++ +The following values are common for this field: ++ +-- +`service`:: A backend service, typically exposing an API. +`website`:: A website. +`library`:: A software library, such as an npm module or a Java library. +-- +<6> Use the `parameters` section to specify parameters for user input that are shown in a form view when a user creates a component by using the Software Template in the {product} console. Each `parameters` subsection, defined by a title and properties, creates a new form page with that definition. +<7> Use the `steps` section to specify steps that are executed in the backend. These steps must be defined by using a unique step ID, a name, and an action. You can view actions that are available on your {product} instance by visiting the URL `\https:///create/actions`. +<8> Use the `output` section to specify the structure of output data that is created when the template is used. The `output` section, particularly the `links` subsection, provides valuable references and URLs that users can utilize to access and interact with components that are created from the template. +<9> Provides a reference or URL to the repository associated with the generated component. +<10> Provides a reference or URL that allows users to open the generated component in a catalog or directory where various components are listed. diff --git a/modules/techdocs/proc-techdocs-edit-docs.adoc b/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-edit-docs.adoc similarity index 92% rename from modules/techdocs/proc-techdocs-edit-docs.adoc rename to modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-edit-docs.adoc index f6aaa08ead..96ec9f6c8b 100644 --- a/modules/techdocs/proc-techdocs-edit-docs.adoc +++ b/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-edit-docs.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE [id="proc-techdocs-edit-docs_{context}"] -= Editing documentation in TechDocs += Making changes to project documentation in TechDocs You can edit a document in your TechDocs plugin directly from the document book page. Any authorized user in your organization can edit a document regardless of whether or not they are the owner of the document. diff --git a/modules/techdocs/proc-techdocs-embed-videos.adoc b/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-embed-videos.adoc similarity index 94% rename from modules/techdocs/proc-techdocs-embed-videos.adoc rename to modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-embed-videos.adoc index c8da38caa3..73cc3ff908 100644 --- a/modules/techdocs/proc-techdocs-embed-videos.adoc +++ b/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-embed-videos.adoc @@ -1,9 +1,9 @@ :_mod-docs-content-type: PROCEDURE [id="proc-techdocs-embed-video_{context}"] -= Embedding videos into TechDocs += Adding video content to enhance TechDocs -You can use `