Skip to content

RHDH-5561: TechDocs content restructure #877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 1 addition & 28 deletions assemblies/assembly-configuring-techdocs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand All @@ -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]

21 changes: 21 additions & 0 deletions modules/techdocs/con-techdocs-about.adoc
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions titles/techdocs/artifacts
1 change: 1 addition & 0 deletions titles/techdocs/assemblies
13 changes: 13 additions & 0 deletions titles/techdocs/docinfo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<title>TechDocs for {product}</title>
<productname>{product}</productname>
<productnumber>{product-version}</productnumber>
<subtitle>
</subtitle>
<abstract>
<para>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.</para>
</abstract>
<authorgroup>
<orgname>{company-name} Customer Content Services</orgname>
</authorgroup>
<xi:include href="Common_Content/Legal_Notice.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
1 change: 1 addition & 0 deletions titles/techdocs/images
13 changes: 13 additions & 0 deletions titles/techdocs/master.adoc
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions titles/techdocs/modules