Skip to content

Commit e43fa0c

Browse files
linfrazelinfraze
authored
RHDH-5561: TechDocs content restructure (redhat-developer#877)
1 parent 3f7845c commit e43fa0c

File tree

8 files changed

+52
-28
lines changed

8 files changed

+52
-28
lines changed

‎assemblies/assembly-configuring-techdocs.adoc

+1-28
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,7 @@
33
[id="{context}"]
44
= Configuring TechDocs
55

6-
Configure the {product} TechDocs plugin to create, find, and use documentation in a central location and in a standardized way. For example:
7-
8-
Docs-like-code approach::
9-
Write your technical documentation in Markdown files that are stored inside your project repository along with your code.
10-
11-
Documentation site generation::
12-
Use MkDocs to create a full-featured, Markdown-based, static HTML site for your documentation that is rendered centrally in {product-short}.
13-
14-
Documentation site metadata and integrations::
15-
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.
16-
17-
Built-in navigation and search::
18-
Find the information that you want from a document more quickly and easily.
19-
20-
Add-ons::
21-
Customize your TechDocs experience with Add-ons to address higher-order documentation needs.
22-
23-
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.
6+
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.
247

258
[IMPORTANT]
269
====
@@ -38,30 +21,20 @@ After you configure {odf-name} to store the files that TechDocs generates, you c
3821
3922
include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]
4023

41-
4224
include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2]
4325

44-
4526
include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2]
4627

47-
4828
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3]
4929

50-
5130
include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2]
5231

53-
5432
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3]
5533

56-
5734
include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1]
5835

59-
6036
include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2]
6137

62-
6338
include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2]
6439

65-
6640
include::modules/customizing-techdocs/proc-techdocs-publish-site.adoc[leveloffset=+2]
67-

‎modules/techdocs/con-techdocs-about.adoc

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="about-techdocs_{context}"]
4+
= About TechDocs
5+
6+
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:
7+
8+
Docs-like-code approach::
9+
Write your technical documentation in Markdown files that are stored inside your project repository along with your code.
10+
11+
Documentation site generation::
12+
Use MkDocs to create a full-featured, Markdown-based, static HTML site for your documentation that is rendered centrally in {product-short}.
13+
14+
Documentation site metadata and integrations::
15+
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.
16+
17+
Built-in navigation and search::
18+
Locate the information that you need within a document quickly and easily.
19+
20+
Add-ons::
21+
Customize your TechDocs experience with add-ons to address higher-order documentation needs.

‎titles/techdocs/artifacts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../artifacts

‎titles/techdocs/assemblies

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../assemblies

‎titles/techdocs/docinfo.xml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<title>TechDocs for {product}</title>
2+
<productname>{product}</productname>
3+
<productnumber>{product-version}</productnumber>
4+
<subtitle>
5+
</subtitle>
6+
<abstract>
7+
<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>
8+
</abstract>
9+
<authorgroup>
10+
<orgname>{company-name} Customer Content Services</orgname>
11+
</authorgroup>
12+
<xi:include href="Common_Content/Legal_Notice.xml"
13+
xmlns:xi="http://www.w3.org/2001/XInclude" />

‎titles/techdocs/images

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images

‎titles/techdocs/master.adoc

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[id="title-techdocs-rhdh"]
2+
include::artifacts/attributes.adoc[]
3+
= TechDocs for {product}
4+
:context: title-techdocs-rhdh
5+
:imagesdir: images
6+
7+
// about techdocs
8+
include::modules/techdocs/con-techdocs-about.adoc[leveloffset=+1]
9+
10+
// techdocs configuration
11+
include::assemblies/assembly-configuring-techdocs.adoc[leveloffset=+1]
12+
13+
// techdocs add-ons

‎titles/techdocs/modules

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules

0 commit comments

Comments
 (0)