RHIDP-6146: Apply review comments

linfraze · openshift-cherrypick-robot · commit 0a7ae290817b · 2025-05-01T06:40:03.000Z
diff --git a/assemblies/assembly-techdocs-add-docs.adoc b/assemblies/assembly-techdocs-add-docs.adoc
@@ -5,4 +5,4 @@
 
 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.
 
-include::modules/techdocs/proc-techdocs-add-doc-github.adoc[]
+include::modules/techdocs/proc-techdocs-add-docs-from-remote-repo.adoc[leveloffset=+1]
diff --git a/assemblies/assembly-using-techdocs.adoc b/assemblies/assembly-using-techdocs.adoc
@@ -7,8 +7,8 @@ The TechDocs plugin is installed and enabled on your {product} instance by defau
 
 include::assembly-techdocs-add-docs.adoc[leveloffset=+1]
 
-include::modules/techdocs/proc-techdocs-find-docs.adoc[]
+include::modules/techdocs/proc-techdocs-find-docs.adoc[leveloffset=+1]
 
-include::modules/techdocs/proc-techdocs-view-docs.adoc[]
+include::modules/techdocs/proc-techdocs-view-docs.adoc[leveloffset=+1]
 
-include::modules/techdocs/proc-techdocs-edit-docs.adoc[]
+include::modules/techdocs/proc-techdocs-edit-docs.adoc[leveloffset=+1]
diff --git a/modules/techdocs/proc-techdocs-add-docs-from-remote-repo.adoc b/modules/techdocs/proc-techdocs-add-docs-from-remote-repo.adoc
@@ -3,14 +3,15 @@
 // * assemblies/assembly-techdocs-add-docs.adoc
 
 :_mod-docs-content-type: PROCEDURE
-[id="proc-techdocs-add-docs-github_{context}"]
-== Importing documentation into TechDocs from a remote repository
+[id="proc-techdocs-add-docs-from-remote-repo_{context}"]
+= Importing documentation into TechDocs from a remote repository
 
-Teams can store their documentation files in the same remote repository where they store their code files. You can import documentation into your TechDocs plugin from a GitHub repository that contains the documentation files that your team uses.
+Teams can store their documentation files in the same remote repository where they store their code files. You can import documentation into your TechDocs plugin from a remote repository that contains the documentation files that your team uses.
 
 .Prerequisites
 
-* Your organization has documentation stored in a GitHub repository.
+* Your organization has documentation files stored in a remote repository.
+* You have a `mkdocs.yaml` file in the root directory of your repository.
 * You have the `catalog.entity.create` and `catalog.location.create` permissions to import documentation into TechDocs from a remote repository.
 
 .Procedure
@@ -26,4 +27,4 @@ Teams can store their documentation files in the same remote repository where th
 .Verification
 
 . In the {product} navigation menu, click *Docs*.
-. Verify that the documentation that you imported is listed in the table on the Documentation page.
+. Verify that the documentation that you imported is listed in the table on the *Documentation* page.
diff --git a/modules/techdocs/proc-techdocs-edit-docs.adoc b/modules/techdocs/proc-techdocs-edit-docs.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="proc-techdocs-edit-docs_{context}"]
-== Editing documentation in TechDocs
+= Editing 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-find-docs.adoc b/modules/techdocs/proc-techdocs-find-docs.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="proc-techdocs-find-docs_{context}"]
-== Finding documentation in TechDocs
+= Finding documentation in TechDocs
 
 By default, the TechDocs plugin *Documentation* page shows all of the documentation that your organization has imported into your {product} instance. You can use any combination of the following methods to find the documentation that you want to view:
 
diff --git a/modules/techdocs/proc-techdocs-view-docs.adoc b/modules/techdocs/proc-techdocs-view-docs.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="proc-techdocs-view-docs_{context}"]
-== Viewing documentation in TechDocs
+= Viewing documentation in TechDocs
 
 In TechDocs, a document might be part of a book that contains other documents that are related to the same topic.
 

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@`
`5`	`5`
`6`	`6`	`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.`
`7`	`7`
`8`		`-include::modules/techdocs/proc-techdocs-add-doc-github.adoc[]`
	`8`	`+include::modules/techdocs/proc-techdocs-add-docs-from-remote-repo.adoc[leveloffset=+1]`