RHIDP-4929 /RHIDP-4930 Moving content to Configuring and Customizing titles (#721)

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

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* Update titles/configuring/master.adoc

* moving procedures on @kadel suggestion

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* fix build

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* reformulate for clarity

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* reformulate for clarity

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* Added app.branding

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* Update assemblies/assembly-configuring-techdocs.adoc

* Update assemblies/assembly-customizing-the-appearance.adoc

* Update modules/configuring/proc-provisioning-your-custom-configuration.adoc

* Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc

* Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc

* Update modules/configuring/proc-adding-custom-configuration-files-by-using-the-operator.adoc

* docs: implemented suggestions

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* Apply suggestions from code review

* Update modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc

* Update modules/configuring/proc-provisioning-your-custom-configuration.adoc

* added product-custom-resource-type attribute

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* v1alpha1 is deprecated, use v1alpha3

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* removed redundant procedure

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* towards more clarity

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* consistent names for database secrets

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* added cross-title links

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* misc fixes

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* misc fixes

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* clarity regarding mandatory vs. optional fields, work on vocabulary

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* Apply suggestions from code review

* Apply suggestions from code review

use attributes

* Update artifacts/attributes.adoc

* applied suggestions

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* fix typo

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* fix broken links, use attributes

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* Update modules/customizing/proc-customizing-your-product-title.adoc

* Update assemblies/assembly-customizing-the-appearance.adoc

* Delete modules/customizing-the-appearance/proc-customize-rhdh-tab-tooltip.adoc

---------

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

Author: themr0c

artifacts/attributes.adoc

@@ -1,5 +1,5 @@
 :red-hat-developers-documentation:
-:imagesdir:
+:imagesdir: images
 :idseparator: -
 
 // Company names
@@ -10,14 +10,22 @@
 :product: Red Hat Developer Hub
 :product-short: Developer Hub
 :product-very-short: RHDH
-:product-version: 1.5
-:product-bundle-version: 1.5.0
-:product-chart-version: 1.5.0
-:product-backstage-version: 1.31.3
+:product-version: 1.4
+:product-bundle-version: 1.4.0
+:product-chart-version: 1.4.0
+:product-backstage-version: 1.29.2
+:product-custom-resource-type: Backstage
 :rhdeveloper-name: Red Hat Developer
 :rhel: Red Hat Enterprise Linux
 :odf-name: OpenShift Data Foundation
 
+:my-app-config-config-map: my-rhdh-app-config
+:my-app-config-file: app-config.yaml
+:my-product-cr-name: my-rhdh-custom-resource
+:my-product-namespace: my-rhdh-project
+:my-product-secrets: my-rhdh-secrets
+:my-product-database-certificates-secrets: my-rhdh-database-certificates-secrets
+:my-product-database-secrets: my-rhdh-database-secrets
 :my-product-url: https://__<my_developer_hub_url>__
 
 // Red Hat Platforms
@@ -72,10 +80,7 @@
 :ug-product-title: Red Hat Developer Hub User Guide
 
 // Links
-:LinkAdminGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index
-:NameOfAdminGuide: Administration guide for {product}
 
-:LinkGettingStartedGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/getting_started_with_red_hat_developer_hub/index
 
 :LinkPluginsGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_plugins_in_red_hat_developer_hub/index
 :NameOfPluginsGuide: Configuring plugins in {product}
@@ -92,6 +97,12 @@
 :authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
 :authorization-book-title: Authorization
 
+:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring/index
+:configuring-book-title: Configuring
+
+:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing/index
+:customizing-book-title: Customizing
+
 :installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
 :installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
 
@@ -113,5 +124,15 @@
 :upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
 :upgrading-book-title: Upgrading {product}
 
+:telemetry-data-collection-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/telemetry_data_collection/index
+:telemetry-data-collection-book-title: Telemetry data collection
+
+:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_log/index
+:audit-log-book-title: Audit log
+
+:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index
+:monitoring-and-logging-book-title: Monitoring and logging
+
 :plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
 :plugins-configure-book-title: Configuring dynamic plugins
+

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"/>

assemblies/assembly-add-custom-app-file-openshift.adoc

@@ -1,5 +1,9 @@
-[id="assembly-running-rhdh-behind-a-proxy"]
-= Running the {product-very-short} application behind a corporate proxy
+:_mod-docs-content-type: ASSEMBLY
+:context: running-behind-a-proxy
+[id="{context}"]
+= Running {product} behind a corporate proxy
+
+In a network restricted environment, configure {product} to use your proxy to access remote network resources.
 
 You can run the {product-very-short} application behind a corporate proxy by setting any of the following environment variables before starting the application:
 
@@ -8,7 +12,8 @@ You can run the {product-very-short} application behind a corporate proxy by set
 
 Additionally, set the `NO_PROXY` environment variable to bypass the proxy for certain domains. The variable value is a comma-separated list of hostnames or IP addresses that can be accessed without the proxy, even if one is specified.
 
-include::modules/admin/procedure-understanding-no-proxy.adoc[leveloffset=+1]
+include::modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1]
+
+
+include::modules/configuring-a-proxy/proc-configuring-proxy-in-helm-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]

assemblies/assembly-running-rhdh-behind-a-proxy.adoc renamed to assemblies/assembly-configuring-a-proxy.adoc

@@ -1,4 +1,6 @@
-[id="assembly-configuring-external-postgresql-databases"]
+:_mod-docs-content-type: ASSEMBLY
+:context: configuring-external-postgresql-databases
+[id="{context}"]
 = 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.
@@ -11,9 +13,11 @@ By default, the {product} operator or Helm Chart creates a local PostgreSQL data
 ====
 
 
-include::modules/admin/proc-configuring-postgresql-instance-using-operator.adoc[leveloffset=+1]
+include::modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc[leveloffset=+1]
 
-include::modules/admin/proc-configuring-postgresql-instance-using-helm.adoc[leveloffset=+1]
 
-include::modules/admin/proc-migrating-databases-to-an-external-server.adoc[leveloffset=+1]
+include::modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc[leveloffset=+1]
+
+
+include::modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc[leveloffset=+1]
 

assemblies/assembly-configuring-external-postgresql-databases.adoc

@@ -1,8 +1,9 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="assembly-techdocs-plugin_{context}"]
-= Configuring the TechDocs plugin in {product}
+:context: configuring-techdocs
+[id="{context}"]
+= Configuring TechDocs
 
-The {product} TechDocs plugin helps your organization create, find, and use documentation in a central location and in a standardized way. For example:
+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.
@@ -35,24 +36,32 @@ After you configure {odf-name} to store the files that TechDocs generates, you c
 
 * For more information, see link:{LinkPluginsGuide}[Configuring plugins in {product}].
 
-//Configuring storage
-include::modules/getting-started/con-techdocs-configure-storage.adoc[leveloffset=+1]
+include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]
 
-include::modules/getting-started/proc-techdocs-using-odf-storage.adoc[leveloffset=+2]
 
-include::modules/getting-started/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2]
+include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2]
 
-include::modules/getting-started/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3]
 
-include::modules/getting-started/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2]
+include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2]
 
-include::modules/getting-started/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3]
 
-//Configuring CI/CD
-include::modules/getting-started/con-techdocs-config-cicd.adoc[leveloffset=+1]
+include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3]
 
-include::modules/getting-started/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2]
 
-include::modules/getting-started/proc-techdocs-generate-site.adoc[leveloffset=+2]
+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]
 
-include::modules/getting-started/proc-techdocs-publish-site.adoc[leveloffset=+2]

assemblies/assembly-techdocs-plugin.adoc renamed to assemblies/assembly-configuring-techdocs.adoc

@@ -1,24 +1,22 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="assembly-admin-templates"]
-= Managing templates
-:context: assembly-admin-templates
+:context: configuring-templates
+[id="{context}"]
+= Configuring templates
 
-toc::[]
+Configure templates to create software components, and publish these components to different locations, such as the {product} software catalog, or Git repositories.
 
 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]
+include::modules/customizing-templates/proc-creating-templates.adoc[leveloffset=+1]
+include::modules/customizing-templates/ref-creating-templates.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 * link:https://backstage.io/docs/features/software-templates/writing-templates[Backstage documentation - Writing Templates]
 * link:https://backstage.io/docs/features/software-templates/builtin-actions[Backstage documentation - Builtin actions]
 * link:https://backstage.io/docs/features/software-templates/writing-custom-actions[Backstage documentation - Writing Custom Actions]
 
-include::modules/templates/proc-adding-templates.adoc[leveloffset=+1]
+include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources

assemblies/assembly-admin-templates.adoc renamed to assemblies/assembly-configuring-templates.adoc

@@ -0,0 +1,47 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: customizing-appearance
+[id="{context}"]
+= Customizing {product} appearance
+
+The following default theme configurations are available for {product}:
+
+The {product} theme:: Default theme configurations to make your developer portal look like a standard {product} instance. For more information, see xref:ref-customize-rhdh-default-rhdh_{context}[]
+
+The Backstage theme:: Default theme configurations to make your developer portal look like a standard Backstage instance. For more information, see xref:ref-customize-rhdh-default-backstage_{context}[]
+
+You can change or disable particular parameters in a default theme or create a fully customized theme by modifying the `app-config-rhdh.yaml` file. From the `app-config-rhdh.yaml` file, you can customize common theme components, including the following:
+
+* Company name and logo
+* Font color, size, and style of text in paragraphs, headings, headers, and buttons
+* Header color, gradient, and shape
+* Button color
+* Navigation indicator color
+
+You can also customize some components from the {product-short} GUI, such as the theme mode (*Light Theme*, *Dark Theme*, or *Auto*).
+
+include::modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-appearance/proc-customize-rhdh-font.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc[leveloffset=+1]
+

assemblies/assembly-customize-rhdh-theme.adoc

@@ -1,5 +1,7 @@
-[id='proc-customize-rhdh-homepage_{context}']
-= Customizing the Home page in {product}
+:_mod-docs-content-type: ASSEMBLY
+:context: customizing-the-home-page
+[id="{context}"]
+= Customizing the Home page
 
 When using the `app-config`, you can do the following:
 
@@ -15,5 +17,8 @@ When using the `app-config`, you can do the following:
 ** Catalog starred entities
 ** 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/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]
+