Merge branch 'main' into RHIDP-4853

themr0c · web-flow · commit 8801321d3eca · 2024-12-03T14:28:10.000+01:00
diff --git a/.asciidoctorconfig b/.asciidoctorconfig
@@ -9,7 +9,6 @@ include::{asciidoctorconfigdir}/artifacts/attributes.adoc[]
 :chapter-signifier: Chapter
 :docinfo: shared
 :docinfodir: {asciidoctorconfigdir}/.asciidoctor
-:doctype: book
 :sectnumlevels: 5
 :sectnums:
 :source-highlighter: coderay
diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc
@@ -94,6 +94,9 @@
 :installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
 :installing-on-ocp-book-title: Installing {product} on {ocp-short}
 
+:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
+:installing-on-gke-book-title: Installing {product} on {gke-brand-name}
+
 :installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
 :installing-on-eks-book-title: Installing {product} on {eks-brand-name}
 
diff --git a/assemblies/assembly-about-rhdh.adoc b/assemblies/assembly-about-rhdh.adoc
@@ -20,4 +20,6 @@ Use {product} to simplify decision-making through a selection of internally appr
 
 
 include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]
-include::modules/about/ref-supported-platforms.adoc[leveloffset=+1]
+include::modules/about/ref-supported-platforms.adoc[leveloffset=+1]
+include::modules/about/ref-rhdh-sizing.adoc[leveloffset=+1]
+include::modules/about/ref-customer-support-info.adoc[leveloffset=+1]
diff --git a/build/scripts/build-ccutil.sh b/build/scripts/build-ccutil.sh
@@ -36,7 +36,7 @@ for t in $(find titles -name master.adoc | sort -uV | grep -E -v "${EXCLUDED_TIT
     CMD="podman run --interactive --rm --tty \
           --volume "$(pwd)":/docs:Z \
           --workdir "/docs/$d" \
-          quay.io/ivanhorvath/ccutil:amazing ccutil compile --format html-single --lang en-US";
+          quay.io/ivanhorvath/ccutil:amazing ccutil compile --format html-single --lang en-US --doctype article";
     echo -e -n "\nBuilding $t into $dest ...\n  ";
     echo "${CMD}" | sed -r -e "s/\  +/ \\\\\n    /g"
     $CMD
diff --git a/modules/about/ref-customer-support-info.adoc b/modules/about/ref-customer-support-info.adoc
@@ -1,8 +1,7 @@
-[preface]
-[id='snip-customer-support-info_{context}']
+[id="ref-customer-support-info_{context}"]
 = Red Hat Developer Hub support
 
 If you experience difficulty with a procedure described in this documentation, visit the http://access.redhat.com[Red Hat Customer Portal]. You can use the Red Hat Customer Portal for the following purposes:
 
-* To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products. 
-* To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for {company-name} Global Support Services (GSS). For support case creation, select *{product}* as the product and select the appropriate product version. For detailed information about supported platforms, see link:{release-notes-url}#con-release-notes-overview.adoc[Supported Platforms] and the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle].
+* To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products.
+* To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for {company-name} Global Support Services (GSS). For support case creation, select *{product}* as the product and select the appropriate product version. For detailed information about supported platforms, see link:{release-notes-url}#con-release-notes-overview.adoc[Supported Platforms] and the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle].
diff --git a/modules/about/ref-rhdh-sizing.adoc b/modules/about/ref-rhdh-sizing.adoc
@@ -0,0 +1,34 @@
+:_mod-docs-content-type: REFERENCE
+[id="rhdh-sizing_{context}"]
+= Sizing requirements for {product}
+
+Scaling the {product} requires significant resource allocation. The following table lists the sizing requirements for installing and running {product}, including {product-short} application, database components, and Operator.
+
+.Recommended sizing for running {product}
+[cols="25%,25%,25%,25%", frame="all", options="header"]
+|===
+|Components
+|{product} application
+|{product} database
+|{product} Operator
+
+|Central Processing Unit (CPU)
+|4 vCPU
+|2 vCPU
+|1 vCPU
+
+|Memory
+|16 GB
+|8 GB
+|1500 Mi
+
+|Storage size
+|2 GB
+|20 GB
+|50 Mi
+
+|Replicas
+|2 or more
+|3 or more
+|1 or more
+|===
diff --git a/modules/about/ref-supported-platforms.adoc b/modules/about/ref-supported-platforms.adoc
@@ -1,7 +1,7 @@
 :_newdoc-version: 2.18.3
 :_template-generated: 2024-11-08
 
-:_mod-docs-content-type: CONCEPT
+:_mod-docs-content-type: REFERENCE
 
 [id="supported-platforms_{context}"]
 = Supported platforms
@@ -12,3 +12,4 @@
 * link:{installing-on-eks-book-url}[{eks-brand-name}]
 * link:{installing-on-aks-book-url}[{aks-brand-name}]
 * link:{installing-on-osd-on-gcp-book-url}[{gcp-brand-name}]
+* link:{installing-on-gke-book-url}[{gke-brand-name}]
diff --git a/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc b/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc
@@ -14,7 +14,7 @@ You can provide data to the Tech Radar page from the following sources:
 .Prerequisites
 
 * You have installed {product} by using either the Operator or Helm chart. For more information, see link:{installing-on-ocp-book-url}[{installing-on-ocp-book-title}].
-* You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `app-config.yaml` file. For example, to configure GitHub as an authentication provider, see link:{authentication-book-url}#authenticating-with-github[Authenticating with GitHub].
+* You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `app-config.yaml` file. For example, to configure GitHub as an integration, see link:{authentication-book-url}#authenticating-with-github[Authenticating with GitHub].
 
 .Procedure
 
diff --git a/modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc b/modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc
@@ -1,7 +1,7 @@
 [id="proc-configuring-an-rhdh-instance-with-tls-in-kubernetes_{context}"]
 = Configuring an {product-very-short} instance with a TLS connection in Kubernetes
 
-You can configure an {product-very-short} instance with a Transport Layer Security (TLS) connection in a Kubernetes cluster, such as an Azure Red Hat OpenShift (ARO) cluster, any cluster from a supported cloud provider, or your own cluster with proper configuration. However, You must use a public Certificate Authority (CA)-signed certificate to configure your Kubernetes cluster.
+You can configure a {product-very-short} instance with a Transport Layer Security (TLS) connection in a Kubernetes cluster, such as an Azure Red Hat OpenShift (ARO) cluster, any cluster from a supported cloud provider, or your own cluster with proper configuration. Transport Layer Security (TLS) ensures a secure connection for the {product-very-short} instance with other entities, such as third-party applications, or external databases. However, you must use a public Certificate Authority (CA)-signed certificate to configure your Kubernetes cluster.
 
 .Prerequisites
 
diff --git a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc
@@ -41,7 +41,7 @@ The internal {ocp-short} cluster image registry cannot be used as a target mirro
 ** The `htpasswd` command is available. For {rhel}, the `htpasswd` command is available by installing the `httpd-tools` package.
 
 .Procedure
-. Download and run the mirroring script to install a custom Operator catalog and mirror the related images: `prepare-restricted-environment.sh` (link:https://github.com/redhat-developer/rhdh-operator/blob/{product-version}.x/.rhdh/scripts/prepare-restricted-environment.sh[source]).
+. Download and run the mirroring script to install a custom Operator catalog and mirror the related images: `prepare-restricted-environment.sh` (link:https://github.com/redhat-developer/rhdh-operator/blob/release-{product-version}/.rhdh/scripts/prepare-restricted-environment.sh[source]).
 +
 [source,yaml,subs="attributes+"]
 ----
diff --git a/titles/about/master.adoc b/titles/about/master.adoc
@@ -1,7 +1,5 @@
 [id="title-about_red_hat_developer_hub"]
 include::artifacts/attributes.adoc[]
-= About {product}
-:doctype: book
 :imagesdir: images
 :title: About {product}
 :subtitle: Introduction to {product}
@@ -13,4 +11,4 @@ include::artifacts/attributes.adoc[]
 //{abstract}
 
 
-include::assemblies/assembly-about-rhdh.adoc[leveloffset=+1]
+include::assemblies/assembly-about-rhdh.adoc[]
diff --git a/titles/admin-rhdh/title-admin.adoc b/titles/admin-rhdh/title-admin.adoc
@@ -2,14 +2,10 @@
 include::artifacts/attributes.adoc[]
 = Administration guide for {product}
 :context: admin-rhdh
-:doctype: book
 :imagesdir: images
 
 {product} is an enterprise-grade, open developer platform that you can use to build developer portals. This platform contains a supported and opinionated framework that helps reduce the friction and frustration of developers while boosting their productivity.
 
-//customer support links
-include::artifacts/snip-customer-support-info.adoc[]
-
 //add a custom application config file to OCP
 include::assemblies/assembly-add-custom-app-file-openshift.adoc[leveloffset=+1]
 
@@ -44,4 +40,4 @@ include::assemblies/assembly-admin-templates.adoc[leveloffset=+1]
 include::assemblies/assembly-techdocs-plugin.adoc[leveloffset=+1]
 
 // RHDH Operator deployment
-include::modules//admin/proc-rhdh-deployment-config.adoc[leveloffset=+1]
+include::modules//admin/proc-rhdh-deployment-config.adoc[leveloffset=+1]
diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc
@@ -1,6 +1,5 @@
 include::artifacts/attributes.adoc[]
 :context: title-audit-log
-:doctype: book
 :imagesdir: images
 :title: Audit log
 :subtitle: Tracking user activities, system events, and data changes with {product} audit logs
@@ -9,4 +8,4 @@ include::artifacts/attributes.adoc[]
 = {title}
 
 // Audit logging
-include::assemblies/assembly-audit-log.adoc[leveloffset=+1]
+include::assemblies/assembly-audit-log.adoc[leveloffset=+1]
diff --git a/titles/authentication/master.adoc b/titles/authentication/master.adoc
@@ -1,6 +1,5 @@
 include::artifacts/attributes.adoc[]
 :context: title-authentication
-:doctype: book
 :imagesdir: images
 :title: Authentication
 :subtitle: Configuring authentication to external services in {product}
diff --git a/titles/authorization/master.adoc b/titles/authorization/master.adoc
@@ -1,6 +1,5 @@
 include::artifacts/attributes.adoc[]
 :context: title-authorization
-:doctype: book
 :imagesdir: images
 :title: Authorization
 :subtitle: Configuring authorization by using role based access control (RBAC) in {product}
diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc
@@ -2,14 +2,10 @@
 include::artifacts/attributes.adoc[]
 = Getting started with {product}
 :context: rhdh-getting-started
-:doctype: book
 :imagesdir: images
 
 As a developer, you can use {product} to experience a streamlined development environment. {product} is driven by a centralized software catalog, providing efficiency to your microservices and infrastructure. It enables your product team to deliver quality code without any compromises.
 
-//customer support links
-include::artifacts/snip-customer-support-info.adoc[]
-
 // supported configs and customization
 include::modules/getting-started/ref-rhdh-supported-configs.adoc[leveloffset=+1]
 include::assemblies/assembly-add-custom-app-file-openshift.adoc[leveloffset=+2]
diff --git a/titles/install-rhdh-air-gapped/master.adoc b/titles/install-rhdh-air-gapped/master.adoc
@@ -2,7 +2,6 @@
 include::artifacts/attributes.adoc[]
 = Installing {product} in an air-gapped environment
 :context: title-install-rhdh-air-grapped
-:doctype: book
 :imagesdir: images
 
 include::modules/installation/con-airgapped-environment.adoc[leveloffset=+1]
diff --git a/titles/install-rhdh-aks/master.adoc b/titles/install-rhdh-aks/master.adoc
@@ -2,7 +2,6 @@
 include::artifacts/attributes.adoc[]
 = Installing {product} on {aks-brand-name}
 :context: title-install-rhdh-aks
-:doctype: book
 :imagesdir: images
 
 // aks deployment
diff --git a/titles/install-rhdh-eks/master.adoc b/titles/install-rhdh-eks/master.adoc
@@ -2,7 +2,6 @@
 include::artifacts/attributes.adoc[]
 = Installing {product} on {eks-brand-name}
 :context: title-install-rhdh-eks
-:doctype: book
 :imagesdir: images
 
 // aws eks deployment
diff --git a/titles/install-rhdh-gke/master.adoc b/titles/install-rhdh-gke/master.adoc
@@ -2,7 +2,6 @@
 include::artifacts/attributes.adoc[]
 = Installing {product} on {gke-brand-name}
 :context: title-install-rhdh-gke
-:doctype: book
 :imagesdir: images
 
 // Google gke deployment - is this required for 1.4 release [TBC]
@@ -19,4 +18,4 @@ include::modules/installation/proc-rhdh-deploy-gke-operator.adoc[leveloffset=+1]
 include::modules/installation/proc-deploy-rhdh-instance-gke.adoc[leveloffset=+2]
 
 // Helm chart method
-include::modules/installation/proc-rhdh-deploy-gke-helm.adoc[leveloffset=+1]
+include::modules/installation/proc-rhdh-deploy-gke-helm.adoc[leveloffset=+1]
diff --git a/titles/install-rhdh-ocp/master.adoc b/titles/install-rhdh-ocp/master.adoc
@@ -2,7 +2,6 @@
 include::artifacts/attributes.adoc[]
 = Installing {product} on {ocp-short}
 :context: title-install-rhdh-ocp
-:doctype: book
 :imagesdir: images
 
 // ocp deployment
@@ -36,4 +35,4 @@ Use the installation method that best meets your needs and preferences.
 include::assemblies/assembly-install-rhdh-ocp-operator.adoc[leveloffset=+1]
 
 // Helm chart method
-include::assemblies/assembly-install-rhdh-ocp-helm.adoc[leveloffset=+1]
+include::assemblies/assembly-install-rhdh-ocp-helm.adoc[leveloffset=+1]
diff --git a/titles/install-rhdh-osd-gcp/master.adoc b/titles/install-rhdh-osd-gcp/master.adoc
@@ -2,7 +2,6 @@
 include::artifacts/attributes.adoc[]
 = Installing {product} on {osd-short} on {gcp-brand-name}
 :context: title-install-rhdh-osd-gcp
-:doctype: book
 :imagesdir: images
 
 You can install {product-short} on {osd-short} on {gcp-brand-name} ({gcp-short}) using one of the following methods:
diff --git a/titles/monitoring-and-logging/master.adoc b/titles/monitoring-and-logging/master.adoc
@@ -1,6 +1,5 @@
 include::artifacts/attributes.adoc[]
 :context: title-monitoring-logging
-:doctype: book
 :imagesdir: images
 :title: Monitoring and logging
 :subtitle: Tracking performance and capturing insights with monitoring and logging tools in {product}
diff --git a/titles/plugin-rhdh/title-plugin.adoc b/titles/plugin-rhdh/title-plugin.adoc
@@ -2,14 +2,10 @@
 include::artifacts/attributes.adoc[]
 = Configuring plugins in {product}
 :context: plugin-rhdh
-:doctype: book
 :imagesdir: images
 
 The {product} is an enterprise-grade, integrated developer platform, extended through plugins, that helps reduce the friction and frustration of developers while boosting their productivity.
 
-//customer support links
-include::artifacts/snip-customer-support-info.adoc[]
-
 //overview
 include::modules/con-rhdh-plugins.adoc[leveloffset=+1]
 
diff --git a/titles/plugins-rhdh-about/master.adoc b/titles/plugins-rhdh-about/master.adoc
@@ -1,11 +1,10 @@
 [id="title-plugins-rhdh-about"]
 include::artifacts/attributes.adoc[]
 :context: title-plugins-rhdh-about
-:doctype: book
 :imagesdir: images
 :title: Introduction to plugins
 :subtitle: Introduction to {product-very-short} plugins
 :abstract: As a {product} user, you can learn about {product} plugins.
 
 = Introduction to plugins
-include::modules/dynamic-plugins/con-rhdh-plugins.adoc[leveloffset=+1]
+include::modules/dynamic-plugins/con-rhdh-plugins.adoc[leveloffset=+1]
diff --git a/titles/plugins-rhdh-configure/master.adoc b/titles/plugins-rhdh-configure/master.adoc
@@ -1,10 +1,9 @@
 include::artifacts/attributes.adoc[]
 :context: title-plugins-rhdh-configure
-:doctype: book
 :imagesdir: images
 
 :title: Configuring dynamic plugins
 :subtitle: Configuring dynamic plugins in {product-very-short} as a platform engineer.
 :abstract: As a platform engineer, you can configure dynamic plugins in {product-very-short} to access your development infrastructure or software development tools.
 
-include::assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc[]
+include::assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc[]
diff --git a/titles/plugins-rhdh-install/master.adoc b/titles/plugins-rhdh-install/master.adoc
@@ -1,10 +1,9 @@
 include::artifacts/attributes.adoc[]
 :context: title-plugins-rhdh-about
-:doctype: book
 :imagesdir: images
 
 :title: Installing and viewing dynamic plugins
 :subtitle: Installing dynamic plugins
 :abstract: Administrative users can install and configure plugins to enable other users to use plugins to extend {product-very-short} functionality.
 
-include::assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc[]
+include::assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc[]
diff --git a/titles/plugins-rhdh-reference/master.adoc b/titles/plugins-rhdh-reference/master.adoc
@@ -1,10 +1,9 @@
 include::artifacts/attributes.adoc[]
 :context: title-plugins-rhdh-about
-:doctype: book
 :imagesdir: images
 
 :title: Dynamic plugins reference
 :subtitle: Working with plugins in {product-very-short}
 :abstract: {product} is preinstalled with a selection of dynamic plugins that users can enable and configure to extend {product-very-short} functionality.
 
-include::assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc[]
+include::assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc[]
diff --git a/titles/plugins-rhdh-troubleshooting/master.adoc b/titles/plugins-rhdh-troubleshooting/master.adoc
@@ -1,6 +1,5 @@
 include::artifacts/attributes.adoc[]
 :context: title-plugins-rhdh-about
-:doctype: book
 :imagesdir: images
 :title: Troubleshooting {product} plugins
 :subtitle: Troubleshooting {product-very-short} plugins
@@ -10,4 +9,4 @@ include::artifacts/attributes.adoc[]
 
 //{abstract}
 
-include::assemblies/dynamic-plugins/assembly-troubleshooting-rhdh-plugins.adoc[]
+include::assemblies/dynamic-plugins/assembly-troubleshooting-rhdh-plugins.adoc[]
diff --git a/titles/plugins-rhdh-using/master.adoc b/titles/plugins-rhdh-using/master.adoc
@@ -1,6 +1,5 @@
 include::artifacts/attributes.adoc[]
 :context: title-plugins-rhdh-using
-:doctype: book
 :imagesdir: images
 :title: Using dynamic plugins
 :subtitle: Using {product-very-short} plugins as an end-user
@@ -10,4 +9,4 @@ include::artifacts/attributes.adoc[]
 
 //{abstract}
 
-include::assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc[]
+include::assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc[]
diff --git a/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc b/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc
@@ -4,14 +4,10 @@ include::artifacts/attributes.adoc[]
 :subtitle: Release notes for {product} {product-version}
 = {title}: {subtitle}
 :context: release-notes-rhdh
-:doctype: book
 :imagesdir: images
 
 {product} ({product-short}) {product-version} is now generally available. {product-short} is a fully supported, enterprise-grade productized version of upstream Backstage v{product-backstage-version}. You can access and download the {product} application from the {company-name} https://access.redhat.com/downloads[Customer Portal] or from the https://catalog.redhat.com/search?gs&q=rhdh&searchType=containers[Ecosystem Catalog].
 
-//customer support links
-include::artifacts/snip-customer-support-info.adoc[]
-
 include::assemblies/assembly-release-notes-new-features.adoc[leveloffset=+1]
 
 
diff --git a/titles/telemetry/master.adoc b/titles/telemetry/master.adoc
@@ -1,6 +1,5 @@
 include::artifacts/attributes.adoc[]
 :context: title-telemetry
-:doctype: book
 :imagesdir: images
 :title: Telemetry data collection
 :subtitle: Collecting and analyzing telemetry data to enhance {product} experience
@@ -9,4 +8,4 @@ include::artifacts/attributes.adoc[]
 = {title}
 
 //Telemetry data collection
-include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]
+include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]
diff --git a/titles/upgrade-rhdh/master.adoc b/titles/upgrade-rhdh/master.adoc

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ The internal {ocp-short} cluster image registry cannot be used as a target mirro`
`41`	`41`	** The `htpasswd` command is available. For {rhel}, the `htpasswd` command is available by installing the `httpd-tools` package.
`42`	`42`
`43`	`43`	`.Procedure`
`44`		-. Download and run the mirroring script to install a custom Operator catalog and mirror the related images: `prepare-restricted-environment.sh` (link:https://github.com/redhat-developer/rhdh-operator/blob/{product-version}.x/.rhdh/scripts/prepare-restricted-environment.sh[source]).
	`44`	+. Download and run the mirroring script to install a custom Operator catalog and mirror the related images: `prepare-restricted-environment.sh` (link:https://github.com/redhat-developer/rhdh-operator/blob/release-{product-version}/.rhdh/scripts/prepare-restricted-environment.sh[source]).
`45`	`45`	`+`
`46`	`46`	`[source,yaml,subs="attributes+"]`
`47`	`47`	`----`