RHIDP-4929 Moving content to dedicated titles for the Configure category

themr0c · themr0c · commit 036002624ca4 · 2024-11-15T15:18:14.000+01:00
Signed-off-by: Fabrice Flore-Thébault &lt;ffloreth@redhat.com&gt;
diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc
@@ -1,5 +1,5 @@
 :red-hat-developers-documentation:
-:imagesdir:
+:imagesdir: images
 :idseparator: -
 
 // Company names
diff --git a/artifacts/docinfo.xml b/artifacts/docinfo.xml
@@ -0,0 +1,11 @@
+<title>{title}</title>
+<productname>{product}</productname>
+<productnumber>{product-version}</productnumber>
+<subtitle>{subtitle}</subtitle>
+<abstract>
+<para>{abstract}</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"/>
diff --git a/assemblies/assembly-add-custom-app-file-openshift.adoc b/assemblies/assembly-add-custom-app-file-openshift.adoc
diff --git a/assemblies/assembly-configuring-external-postgresql-databases.adoc b/assemblies/assembly-configuring-external-postgresql-databases.adoc
@@ -1,7 +1,8 @@
 [id="assembly-configuring-external-postgresql-databases"]
 = Configuring external PostgreSQL databases
 
-As an administrator, you can configure and use external PostgreSQL databases in {product}. You can use a PostgreSQL certificate file to configure an external PostgreSQL instance using the Operator or Helm Chart.
+As an administrator, you can configure and use external PostgreSQL databases in {product}.
+You can use a PostgreSQL certificate file to configure an external PostgreSQL instance using the Operator or Helm Chart.
 
 [NOTE]
 ====
diff --git a/assemblies/assembly-configuring-techdocs.adoc b/assemblies/assembly-configuring-techdocs.adoc
@@ -2,7 +2,8 @@
 [id="assembly-techdocs-plugin_{context}"]
 = Configuring the TechDocs plugin in {product}
 
-The {product} TechDocs plugin helps your organization create, find, and use documentation in a central location and in a standardized way. For example:
+{abstract}
+For example:
 
 Docs-like-code approach::
 Write your technical documentation in Markdown files that are stored inside your project repository along with your code.
diff --git a/assemblies/assembly-configuring-templates.adoc b/assemblies/assembly-configuring-templates.adoc
@@ -1,14 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="assembly-admin-templates"]
-= Managing templates
+= Configuring templates
 :context: assembly-admin-templates
 
-toc::[]
+{abstract}
 
 A template is a form composed of different UI fields that is defined in a YAML file. Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally.
 
-You can use templates to easily create {product} components, and then publish these components to different locations, such as the {product} software catalog, or repositories in GitHub or GitLab.
-
 include::modules/templates/proc-creating-templates.adoc[leveloffset=+1]
 include::modules/templates/ref-creating-templates.adoc[leveloffset=+1]
 
diff --git a/assemblies/assembly-customizing-the-rhdh-homepage.adoc b/assemblies/assembly-customizing-the-rhdh-homepage.adoc
@@ -1,4 +1,4 @@
-[id='proc-customize-rhdh-homepage_{context}']
+[id='proc-customize-rhdh-homepage']
 = Customizing the Home page in {product}
 
 When using the `app-config`, you can do the following:
@@ -16,4 +16,4 @@ When using the `app-config`, you can do the following:
 ** Featured docs
 
 include::modules/getting-started/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]
-include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]
+include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]
diff --git a/assemblies/assembly-rhdh-integration-aws.adoc b/assemblies/assembly-rhdh-integration-aws.adoc
diff --git a/assemblies/assembly-running-behind-a-proxy.adoc b/assemblies/assembly-running-behind-a-proxy.adoc
@@ -1,13 +1,15 @@
 [id="assembly-running-rhdh-behind-a-proxy"]
 = Running the {product-very-short} application behind a corporate proxy
 
+{abstract}
+
 You can run the {product-very-short} application behind a corporate proxy by setting any of the following environment variables before starting the application:
 
 * `HTTP_PROXY`: Denotes the proxy to use for HTTP requests.
 * `HTTPS_PROXY`: Denotes the proxy to use for HTTPS requests.
 
 Additionally, you can set the `NO_PROXY` environment variable to exclude certain domains from proxying. The variable value is a comma-separated list of hostnames that do not require a proxy to get reached, even if one is specified.
 
+include::modules/admin/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1]
 
 include::modules/admin/proc-configuring-proxy-in-helm-deployment.adoc[leveloffset=+1]
-include::modules/admin/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1]
diff --git a/modules/getting-started/proc-customize-rhdh-learning-paths.adoc b/modules/getting-started/proc-customize-rhdh-learning-paths.adoc
@@ -7,7 +7,7 @@ In {product}, you can configure Learning Paths by passing the data into the `app
 ====
 Due to the use of overlapping `pathRewrites` for both the `learning-path` and `homepage` quick access proxies, you must create the `learning-paths` configuration (`^api/proxy/developer-hub/learning-paths`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`).
 
-For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage_rhdh-getting-started[Customizing the Home page in {product}].
+For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage[Customizing the Home page in {product}].
 ====
 
 You can provide data to the Learning Path from the following sources:
diff --git a/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc b/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc
@@ -9,7 +9,7 @@ In {product}, you can configure Learning Paths by passing the data into the `app
 ====
 Due to the use of overlapping `pathRewrites` for both the `tech-radar` and `homepage` quick access proxies, you must create the `tech-radar` configuration (`^api/proxy/developer-hub/tech-radar`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`).
 
-For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage_rhdh-getting-started[Customizing the Home page in {product}].
+For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage[Customizing the Home page in {product}].
 ====
 
 You can provide data to the Tech Radar page from the following sources:
diff --git a/modules/templates/proc-adding-templates.adoc b/modules/templates/proc-adding-templates.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * assemblies/assembly-admin-templates.adoc
+// * assemblies/assembly-configuring-templates.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="proc-adding-templates_{context}"]
diff --git a/modules/templates/proc-creating-templates.adoc b/modules/templates/proc-creating-templates.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * assemblies/assembly-admin-templates.adoc
+// * assemblies/assembly-configuring-templates.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="proc-creating-templates_{context}"]
diff --git a/modules/templates/ref-creating-templates.adoc b/modules/templates/ref-creating-templates.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * assemblies/assembly-admin-templates.adoc
+// * assemblies/assembly-configuring-templates.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="ref-creating-templates_{context}"]
diff --git a/titles/admin-rhdh/docinfo.xml b/titles/admin-rhdh/docinfo.xml
diff --git a/titles/admin-rhdh/master.adoc b/titles/admin-rhdh/master.adoc
diff --git a/titles/admin-rhdh/title-admin.adoc b/titles/admin-rhdh/title-admin.adoc
diff --git a/titles/configuring-external-databases/artifacts b/titles/configuring-external-databases/artifacts
@@ -0,0 +1 @@
+../../artifacts/
diff --git a/titles/configuring-external-databases/assemblies b/titles/configuring-external-databases/assemblies
@@ -0,0 +1 @@
+../../assemblies/
diff --git a/titles/configuring-external-databases/docinfo.xml b/titles/configuring-external-databases/docinfo.xml
@@ -0,0 +1 @@
+../../artifacts/docinfo.xml
diff --git a/titles/configuring-external-databases/images b/titles/configuring-external-databases/images
diff --git a/titles/configuring-external-databases/master.adoc b/titles/configuring-external-databases/master.adoc
@@ -0,0 +1,7 @@
+include::artifacts/attributes.adoc[]
+:doctype: book
+:title: Configuring external databases
+:subtitle: Configuring {product} to use external PostgreSQL databases
+:abstract: As an administrator, you can configure and use external PostgreSQL databases in {product}.
+:context: configuring-external-postgresql-databases
+include::assemblies/assembly-configuring-external-postgresql-databases.adoc[]
diff --git a/titles/configuring-external-databases/modules b/titles/configuring-external-databases/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/titles/configuring-proxy/artifacts b/titles/configuring-proxy/artifacts
@@ -0,0 +1 @@
+../../artifacts/
diff --git a/titles/configuring-proxy/assemblies b/titles/configuring-proxy/assemblies
@@ -0,0 +1 @@
+../../assemblies/
diff --git a/titles/configuring-proxy/docinfo.xml b/titles/configuring-proxy/docinfo.xml
@@ -0,0 +1 @@
+../../artifacts/docinfo.xml
diff --git a/titles/configuring-proxy/images b/titles/configuring-proxy/images
@@ -0,0 +1 @@
+../../images
diff --git a/titles/configuring-proxy/master.adoc b/titles/configuring-proxy/master.adoc
@@ -0,0 +1,7 @@
+include::artifacts/attributes.adoc[]
+:doctype: book
+:title: Running behind a proxy
+:subtitle: Running {product} behind a proxy
+:abstract: In a network restricted environment, configure {product} to use your proxy to access remote network resources.
+:context: running-behind-a-proxy
+include::assemblies/assembly-running-behind-a-proxy.adoc[]
diff --git a/titles/configuring-proxy/modules b/titles/configuring-proxy/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/titles/configuring-rhdh-by-using-helm/artifacts b/titles/configuring-rhdh-by-using-helm/artifacts
@@ -0,0 +1 @@
+../../artifacts/
diff --git a/titles/configuring-rhdh-by-using-helm/assemblies b/titles/configuring-rhdh-by-using-helm/assemblies
@@ -0,0 +1 @@
+../../assemblies/
diff --git a/titles/configuring-rhdh-by-using-helm/docinfo.xml b/titles/configuring-rhdh-by-using-helm/docinfo.xml
@@ -0,0 +1 @@
+../../artifacts/docinfo.xml
diff --git a/titles/configuring-rhdh-by-using-helm/images b/titles/configuring-rhdh-by-using-helm/images
@@ -0,0 +1 @@
+../../images
diff --git a/titles/configuring-rhdh-by-using-helm/master.adoc b/titles/configuring-rhdh-by-using-helm/master.adoc
@@ -0,0 +1,13 @@
+include::artifacts/attributes.adoc[]
+:doctype: book
+:title: Configuring {product} by using Helm
+:subtitle: Adding custom configuration files to {product}
+:abstract: To configure {product}, add custom configuration files to {ocp-brand-name} and register them in {product-short}.
+:context: adding-custom-configuration-files
+[id="{context}"]
+= {title}
+
+{abstract}
+
+include::modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc[leveloffset=+1]
+
diff --git a/titles/configuring-rhdh-by-using-helm/modules b/titles/configuring-rhdh-by-using-helm/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/titles/configuring-rhdh-by-using-the-operator/artifacts b/titles/configuring-rhdh-by-using-the-operator/artifacts
@@ -0,0 +1 @@
+../../artifacts/
diff --git a/titles/configuring-rhdh-by-using-the-operator/assemblies b/titles/configuring-rhdh-by-using-the-operator/assemblies
@@ -0,0 +1 @@
+../../assemblies/
diff --git a/titles/configuring-rhdh-by-using-the-operator/docinfo.xml b/titles/configuring-rhdh-by-using-the-operator/docinfo.xml
@@ -0,0 +1 @@
+../../artifacts/docinfo.xml
diff --git a/titles/configuring-rhdh-by-using-the-operator/images b/titles/configuring-rhdh-by-using-the-operator/images
@@ -0,0 +1 @@
+../../images/
diff --git a/titles/configuring-rhdh-by-using-the-operator/master.adoc b/titles/configuring-rhdh-by-using-the-operator/master.adoc
@@ -0,0 +1,14 @@
+include::artifacts/attributes.adoc[]
+:doctype: book
+:title: Configuring {product} by using the operator
+:subtitle: Adding custom configuration files to {product}
+:abstract: To configure {product}, add custom configuration files to {ocp-brand-name} and register them in {product-short}.
+:context: adding-custom-configuration-files
+[id="{context}"]
+= {title}
+
+{abstract}
+
+include::modules/installation/proc-add-custom-app-config-file-ocp-operator.adoc[leveloffset=+1]
+
+include::modules//admin/proc-rhdh-deployment-config.adoc[leveloffset=+1]
diff --git a/titles/configuring-rhdh-by-using-the-operator/modules b/titles/configuring-rhdh-by-using-the-operator/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/titles/configuring-techdocs/artifacts b/titles/configuring-techdocs/artifacts
@@ -0,0 +1 @@
+../../artifacts/
diff --git a/titles/configuring-techdocs/assemblies b/titles/configuring-techdocs/assemblies
@@ -0,0 +1 @@
+../../assemblies/
diff --git a/titles/configuring-techdocs/docinfo.xml b/titles/configuring-techdocs/docinfo.xml
@@ -0,0 +1 @@
+../../artifacts/docinfo.xml
diff --git a/titles/configuring-techdocs/images b/titles/configuring-techdocs/images
@@ -0,0 +1 @@
+../../images
diff --git a/titles/configuring-techdocs/master.adoc b/titles/configuring-techdocs/master.adoc
@@ -0,0 +1,7 @@
+include::artifacts/attributes.adoc[]
+:doctype: book
+:title: Configuring TechDocs
+:subtitle: Configuring the {product} TechDocs plugin
+:abstract: Configure the {product} TechDocs plugin to create, find, and use documentation in a central location and in a standardized way.
+:context: configuring-techdocs
+include::assemblies/assembly-configuring-techdocs.adoc[]
diff --git a/titles/configuring-techdocs/modules b/titles/configuring-techdocs/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/titles/configuring-templates/artifacts b/titles/configuring-templates/artifacts
@@ -0,0 +1 @@
+../../artifacts/
diff --git a/titles/configuring-templates/assemblies b/titles/configuring-templates/assemblies
@@ -0,0 +1 @@
+../../assemblies/
diff --git a/titles/configuring-templates/docinfo.xml b/titles/configuring-templates/docinfo.xml
@@ -0,0 +1 @@
+../../artifacts/docinfo.xml
diff --git a/titles/configuring-templates/images b/titles/configuring-templates/images
@@ -0,0 +1 @@
+../../images
diff --git a/titles/configuring-templates/master.adoc b/titles/configuring-templates/master.adoc
@@ -0,0 +1,7 @@
+include::artifacts/attributes.adoc[]
+:doctype: book
+:title: Configuring templates
+:subtitle: Configuring {product} templates
+:abstract: Configure templates to create software components, and publish these components to different locations, such as the {product} software catalog, or Git repositories.
+:context: configuring-techdocs
+include::assemblies/assembly-configuring-templates.adoc[]
diff --git a/titles/configuring-templates/modules b/titles/configuring-templates/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/titles/configuring-tls/artifacts b/titles/configuring-tls/artifacts
diff --git a/titles/configuring-tls/assemblies b/titles/configuring-tls/assemblies
diff --git a/titles/configuring-tls/docinfo.xml b/titles/configuring-tls/docinfo.xml
@@ -0,0 +1 @@
+../../artifacts/docinfo.xml
diff --git a/titles/configuring-tls/images b/titles/configuring-tls/images
@@ -0,0 +1 @@
+../../images
diff --git a/titles/configuring-tls/master.adoc b/titles/configuring-tls/master.adoc
@@ -0,0 +1,7 @@
+include::artifacts/attributes.adoc[]
+:doctype: book
+:title: Configuring TLS
+:subtitle: Configuring {product} with a TLS connection in Kubernetes
+:abstract: You can configure an {product} instance with a Transport Layer Security (TLS) connection in a Kubernetes cluster.
+:context: configuring-techdocs
+include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc[]
diff --git a/titles/configuring-tls/modules b/titles/configuring-tls/modules
diff --git a/titles/customizing-appearance/artifacts b/titles/customizing-appearance/artifacts
diff --git a/titles/customizing-appearance/assemblies b/titles/customizing-appearance/assemblies
diff --git a/titles/customizing-appearance/docinfo.xml b/titles/customizing-appearance/docinfo.xml
diff --git a/titles/customizing-appearance/images b/titles/customizing-appearance/images
diff --git a/titles/customizing-appearance/master.adoc b/titles/customizing-appearance/master.adoc
diff --git a/titles/customizing-appearance/modules b/titles/customizing-appearance/modules
diff --git a/titles/discover/master.adoc b/titles/discover/master.adoc
diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc
diff --git a/titles/install-rhdh-aks/master.adoc b/titles/install-rhdh-aks/master.adoc
diff --git a/titles/installation-rhdh/artifacts b/titles/installation-rhdh/artifacts
diff --git a/titles/installation-rhdh/assemblies b/titles/installation-rhdh/assemblies
diff --git a/titles/installation-rhdh/images b/titles/installation-rhdh/images
diff --git a/titles/installation-rhdh/modules b/titles/installation-rhdh/modules
