diff --git a/assemblies/assembly-configuring-techdocs.adoc b/assemblies/assembly-configuring-techdocs.adoc index 2242fb5151..9c35554c7c 100644 --- a/assemblies/assembly-configuring-techdocs.adoc +++ b/assemblies/assembly-configuring-techdocs.adoc @@ -3,24 +3,7 @@ [id="{context}"] = Configuring TechDocs -Configure the {product} TechDocs plugin to create, find, and use documentation in a central location and in a standardized way. For example: - -Docs-like-code approach:: -Write your technical documentation in Markdown files that are stored inside your project repository along with your code. - -Documentation site generation:: -Use MkDocs to create a full-featured, Markdown-based, static HTML site for your documentation that is rendered centrally in {product-short}. - -Documentation site metadata and integrations:: -See additional metadata about the documentation site alongside the static documentation, such as the date of the last update, the site owner, top contributors, open GitHub issues, Slack support channels, and Stack Overflow Enterprise tags. - -Built-in navigation and search:: -Find the information that you want from a document more quickly and easily. - -Add-ons:: -Customize your TechDocs experience with Add-ons to address higher-order documentation needs. - -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 config map. +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] ==== @@ -38,30 +21,20 @@ After you configure {odf-name} to store the files that TechDocs generates, you c include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1] - include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2] - include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2] - include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3] - include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2] - include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3] - include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1] - include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2] - include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2] - include::modules/customizing-techdocs/proc-techdocs-publish-site.adoc[leveloffset=+2] - diff --git a/modules/techdocs/con-techdocs-about.adoc b/modules/techdocs/con-techdocs-about.adoc new file mode 100644 index 0000000000..9b3a854104 --- /dev/null +++ b/modules/techdocs/con-techdocs-about.adoc @@ -0,0 +1,21 @@ +:_mod-docs-content-type: CONCEPT + +[id="about-techdocs_{context}"] += About TechDocs + +The {product} instance comes with the TechDocs plugin preinstalled and enabled by default. Your organization can use the TechDocs plugin to create, find, and manage documentation in a central location and in a standardized way. You can also enhance your technical documentation experience with built-in TechDocs features and add-ons. For example: + +Docs-like-code approach:: +Write your technical documentation in Markdown files that are stored inside your project repository along with your code. + +Documentation site generation:: +Use MkDocs to create a full-featured, Markdown-based, static HTML site for your documentation that is rendered centrally in {product-short}. + +Documentation site metadata and integrations:: +See additional metadata about the documentation site alongside the static documentation, such as the date of the last update, the site owner, top contributors, open GitHub issues, Slack support channels, and Stack Overflow Enterprise tags. + +Built-in navigation and search:: +Locate the information that you need within a document quickly and easily. + +Add-ons:: +Customize your TechDocs experience with add-ons to address higher-order documentation needs. diff --git a/titles/techdocs/artifacts b/titles/techdocs/artifacts new file mode 120000 index 0000000000..f30b6dea60 --- /dev/null +++ b/titles/techdocs/artifacts @@ -0,0 +1 @@ +../../artifacts \ No newline at end of file diff --git a/titles/techdocs/assemblies b/titles/techdocs/assemblies new file mode 120000 index 0000000000..91646274db --- /dev/null +++ b/titles/techdocs/assemblies @@ -0,0 +1 @@ +../../assemblies \ No newline at end of file diff --git a/titles/techdocs/docinfo.xml b/titles/techdocs/docinfo.xml new file mode 100644 index 0000000000..42d897b71d --- /dev/null +++ b/titles/techdocs/docinfo.xml @@ -0,0 +1,13 @@ +TechDocs for {product} +{product} +{product-version} + + + + Your organization can use the built-in TechDocs plugin for {product} to create, find, and use technical documentation in a central location and in a standardized way. Use supported TechDocs add-ons, or create your own, to further enhance your documentation experience. + + + {company-name} Customer Content Services + + diff --git a/titles/techdocs/images b/titles/techdocs/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/techdocs/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/techdocs/master.adoc b/titles/techdocs/master.adoc new file mode 100644 index 0000000000..649b8bb685 --- /dev/null +++ b/titles/techdocs/master.adoc @@ -0,0 +1,13 @@ +[id="title-techdocs-rhdh"] +include::artifacts/attributes.adoc[] += TechDocs for {product} +:context: title-techdocs-rhdh +:imagesdir: images + +// about techdocs +include::modules/techdocs/con-techdocs-about.adoc[leveloffset=+1] + +// techdocs configuration +include::assemblies/assembly-configuring-techdocs.adoc[leveloffset=+1] + +// techdocs add-ons diff --git a/titles/techdocs/modules b/titles/techdocs/modules new file mode 120000 index 0000000000..8b0e854007 --- /dev/null +++ b/titles/techdocs/modules @@ -0,0 +1 @@ +../../modules \ No newline at end of file