From e7d900bda737603f9fce119a78235d1555c82296 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Mon, 3 Nov 2025 10:46:10 +0530 Subject: [PATCH 01/14] Added title - manage and consume techdocs --- ...nage-and-consume-techdoc-within-rhdh.adoc} | 7 ++- ...ne-software-development-and-managment.adoc | 5 +++ assemblies/assembly-techdocs-add-docs.adoc | 2 +- modules/techdocs/proc-techdocs-edit-docs.adoc | 2 +- .../techdocs/proc-techdocs-embed-videos.adoc | 4 +- modules/techdocs/proc-techdocs-find-docs.adoc | 4 +- ...proc-techdocs-pipeline-github-actions.adoc | 2 +- modules/techdocs/proc-techdocs-view-docs.adoc | 2 +- .../artifacts | 1 + .../assemblies | 1 + .../docinfo.xml | 1 + .../images | 1 + .../master.adoc | 8 ++++ .../modules | 1 + .../artifacts | 1 + .../assemblies | 1 + .../docinfo.xml | 1 + .../images | 1 + .../master.adoc | 44 +++++++++++++++++++ .../modules | 1 + titles/techdocs/master.adoc | 3 +- 21 files changed, 81 insertions(+), 12 deletions(-) rename assemblies/{assembly-using-techdocs.adoc => assembly-manage-and-consume-techdoc-within-rhdh.adoc} (78%) create mode 100644 assemblies/assembly-streamline-software-development-and-managment.adoc create mode 120000 titles/manage-and-consume-techdoc-within-rhdh/artifacts create mode 120000 titles/manage-and-consume-techdoc-within-rhdh/assemblies create mode 120000 titles/manage-and-consume-techdoc-within-rhdh/docinfo.xml create mode 120000 titles/manage-and-consume-techdoc-within-rhdh/images create mode 100644 titles/manage-and-consume-techdoc-within-rhdh/master.adoc create mode 120000 titles/manage-and-consume-techdoc-within-rhdh/modules create mode 120000 titles/streamline-software-development-and-managment/artifacts create mode 120000 titles/streamline-software-development-and-managment/assemblies create mode 120000 titles/streamline-software-development-and-managment/docinfo.xml create mode 120000 titles/streamline-software-development-and-managment/images create mode 100644 titles/streamline-software-development-and-managment/master.adoc create mode 120000 titles/streamline-software-development-and-managment/modules diff --git a/assemblies/assembly-using-techdocs.adoc b/assemblies/assembly-manage-and-consume-techdoc-within-rhdh.adoc similarity index 78% rename from assemblies/assembly-using-techdocs.adoc rename to assemblies/assembly-manage-and-consume-techdoc-within-rhdh.adoc index 14ac67075d..9dee452159 100644 --- a/assemblies/assembly-using-techdocs.adoc +++ b/assemblies/assembly-manage-and-consume-techdoc-within-rhdh.adoc @@ -1,8 +1,8 @@ :_mod-docs-content-type: ASSEMBLY -:context: assembly-using-techdocs +:context: assembly-manage-and-consume-techdoc-within-rhdh [id="{context}"] -= Using TechDocs += 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. @@ -19,3 +19,6 @@ 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] + +:_mod-docs-content-type: ASSEMBLY +:context: assembly-manage-and-consume-techdoc-within-rhdh \ No newline at end of file diff --git a/assemblies/assembly-streamline-software-development-and-managment.adoc b/assemblies/assembly-streamline-software-development-and-managment.adoc new file mode 100644 index 0000000000..ca64c45197 --- /dev/null +++ b/assemblies/assembly-streamline-software-development-and-managment.adoc @@ -0,0 +1,5 @@ +:_mod-docs-content-type: ASSEMBLY +:context: streamline-software-development-and-managment + +[id="{context}"] += Streamline Software development and management 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/modules/techdocs/proc-techdocs-edit-docs.adoc b/modules/techdocs/proc-techdocs-edit-docs.adoc index f6aaa08ead..96ec9f6c8b 100644 --- a/modules/techdocs/proc-techdocs-edit-docs.adoc +++ b/modules/techdocs/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/techdocs/proc-techdocs-embed-videos.adoc index c8da38caa3..73cc3ff908 100644 --- a/modules/techdocs/proc-techdocs-embed-videos.adoc +++ b/modules/techdocs/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 `