Merge branch 'release-1.4' into move-community-to-tp

Author: nickboldt

artifacts/attributes.adoc

@@ -1,5 +1,5 @@
 :red-hat-developers-documentation:
-:imagesdir:
+:imagesdir: images
 :idseparator: -
 
 // Company names
@@ -14,10 +14,18 @@
 :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
@@ -29,14 +37,16 @@
 :logging-brand-name: Red Hat OpenShift Logging
 :logging-short: OpenShift Logging
 // minimum and current latest supported versions
-:ocp-version-min: 4.14
+:ocp-version-min: 4.16
 :ocp-version: 4.17
+:kubernetes-version: 1.24
 // First mention of OpenShift CLI or `oc` in a module
 :openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
 :rhsso-brand-name: Red Hat Single-Sign On
 :rhsso: RHSSO
 :rhbk-brand-name: Red Hat Build of Keycloak
 :rhbk: RHBK
+:keycloak-version: 24.0
 
 // Partner Platforms
 :aws-brand-name: Amazon Web Services
@@ -70,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}
@@ -90,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}
 
@@ -111,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"/>

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc

@@ -6,17 +6,22 @@ The Keycloak backend plugin, which integrates Keycloak into {product-short}, has
 * Synchronization of Keycloak users in a realm.
 * Synchronization of Keycloak groups and their users in a realm.
 
+[NOTE]
+====
+The supported Keycloak version is `{keycloak-version}`.
+====
+
 == Installation
 
 The Keycloak plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows:
 
 [source,yaml]
 ----
-global: 
-  dynamic: 
-    includes: 
+global:
+  dynamic:
+    includes:
       - dynamic-plugins.default.yaml
-    plugins: 
+    plugins:
       - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic
         disabled: false
 ----

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-readme.adoc

@@ -1,5 +1,5 @@
 [id="rhdh-keycloak_{context}"]
-= Installation and configuration of Keycloak 
+= Installation and configuration of Keycloak
 
 The Keycloak backend plugin, which integrates Keycloak into {product-short}, has the following capabilities:
 
@@ -14,11 +14,11 @@ The Keycloak plugin is pre-loaded in {product-short} with basic configuration pr
 
 [source,yaml]
 ----
-global: 
-  dynamic: 
-    includes: 
+global:
+  dynamic:
+    includes:
       - dynamic-plugins.default.yaml
-    plugins: 
+    plugins:
       - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic
         disabled: false
 ----

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc

@@ -1,5 +1,5 @@
 [id="rhdh-keycloak_{context}"]
-= Using Keycloak 
+= Using Keycloak
 
 The Keycloak backend plugin, which integrates Keycloak into {product-short}, has the following capabilities:
 

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