From 414c8037729bcae4837d8e45783996a54c0665fd Mon Sep 17 00:00:00 2001 From: jmagak <124673476+jmagak@users.noreply.github.com> Date: Thu, 28 Nov 2024 09:05:38 +0100 Subject: [PATCH] Resolve conflicts in PR 743 --- artifacts/attributes.adoc | 10 ++++-- assemblies/assembly-about-rhdh.adoc | 4 ++- .../con-benefits-of-rhdh.adoc | 0 modules/about/ref-rhdh-sizing.adoc | 34 +++++++++++++++++++ modules/about/ref-supported-platforms.adoc | 15 ++++++++ titles/{discover => about}/artifacts | 0 titles/{discover => about}/assemblies | 0 titles/about/docinfo.xml | 11 ++++++ titles/{discover => about}/images | 0 titles/{discover => about}/master.adoc | 9 ++--- titles/{discover => about}/modules | 0 titles/discover/docinfo.xml | 11 ------ 12 files changed, 76 insertions(+), 18 deletions(-) rename modules/{discover => about}/con-benefits-of-rhdh.adoc (100%) create mode 100644 modules/about/ref-rhdh-sizing.adoc create mode 100644 modules/about/ref-supported-platforms.adoc rename titles/{discover => about}/artifacts (100%) rename titles/{discover => about}/assemblies (100%) create mode 100644 titles/about/docinfo.xml rename titles/{discover => about}/images (100%) rename titles/{discover => about}/master.adoc (68%) rename titles/{discover => about}/modules (100%) delete mode 100644 titles/discover/docinfo.xml diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index 705869c6ea..8de3d51df9 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -86,10 +86,16 @@ :authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index :authorization-book-title: Authorization -:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_openshift_container_platform/index +: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} + +: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-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index +: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} :installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index diff --git a/assemblies/assembly-about-rhdh.adoc b/assemblies/assembly-about-rhdh.adoc index d6cf246a86..4c7b4ecd69 100644 --- a/assemblies/assembly-about-rhdh.adoc +++ b/assemblies/assembly-about-rhdh.adoc @@ -19,4 +19,6 @@ This platform is driven by a centralized software catalog, providing efficiency Use {product} to simplify decision-making through a selection of internally approved tools, programming languages, and developer resources within a self-managed portal. -include::modules/discover/con-benefits-of-rhdh.adoc[leveloffset=+1] +include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1] +include::modules/about/ref-supported-platforms.adoc[leveloffset=+1] +include::modules/about/ref-rhdh-sizing.adoc[leveloffset=+1] diff --git a/modules/discover/con-benefits-of-rhdh.adoc b/modules/about/con-benefits-of-rhdh.adoc similarity index 100% rename from modules/discover/con-benefits-of-rhdh.adoc rename to modules/about/con-benefits-of-rhdh.adoc diff --git a/modules/about/ref-rhdh-sizing.adoc b/modules/about/ref-rhdh-sizing.adoc new file mode 100644 index 0000000000..6310c0c635 --- /dev/null +++ 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 new file mode 100644 index 0000000000..974dd6a9e4 --- /dev/null +++ b/modules/about/ref-supported-platforms.adoc @@ -0,0 +1,15 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-11-08 + +:_mod-docs-content-type: REFERENCE + +[id="supported-platforms_{context}"] += Supported platforms + +{product} runs on {ocp-short} {ocp-version-min}-{ocp-version} on supported architectures and providers, such as: + +* link:{installing-on-ocp-book-url}[{ocp-brand-name} {ocp-version-min}-{ocp-version}] +* 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/titles/discover/artifacts b/titles/about/artifacts similarity index 100% rename from titles/discover/artifacts rename to titles/about/artifacts diff --git a/titles/discover/assemblies b/titles/about/assemblies similarity index 100% rename from titles/discover/assemblies rename to titles/about/assemblies diff --git a/titles/about/docinfo.xml b/titles/about/docinfo.xml new file mode 100644 index 0000000000..60f431eb6e --- /dev/null +++ b/titles/about/docinfo.xml @@ -0,0 +1,11 @@ +About {product} +{product} +{product-version} +Introduction to {product} + + {product} is a developer platform designed to build developer portals. Use {product} to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently. + + + {company-name} Customer Content Services + + diff --git a/titles/discover/images b/titles/about/images similarity index 100% rename from titles/discover/images rename to titles/about/images diff --git a/titles/discover/master.adoc b/titles/about/master.adoc similarity index 68% rename from titles/discover/master.adoc rename to titles/about/master.adoc index 55147faff6..9f2b764ec4 100644 --- a/titles/discover/master.adoc +++ b/titles/about/master.adoc @@ -1,14 +1,15 @@ +[id="title-about_red_hat_developer_hub"] include::artifacts/attributes.adoc[] -:context: title-discover += About {product} :doctype: book :imagesdir: images -:title: Discover +:title: About {product} :subtitle: Introduction to {product} -:abstract: {product} is a developer platform designed to build developer portals. Use {product} to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently. +:abstract: {product} is a developer platform designed to build developer portals. Use {product} to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently. //[id="{context}"] //= {title} //{abstract} -include::assemblies/assembly-about-rhdh.adoc[] +include::assemblies/assembly-about-rhdh.adoc[] \ No newline at end of file diff --git a/titles/discover/modules b/titles/about/modules similarity index 100% rename from titles/discover/modules rename to titles/about/modules diff --git a/titles/discover/docinfo.xml b/titles/discover/docinfo.xml deleted file mode 100644 index 5f7fe2ebac..0000000000 --- a/titles/discover/docinfo.xml +++ /dev/null @@ -1,11 +0,0 @@ -{title} -{product} -{product-version} -{subtitle} - - {abstract} - - - {company-name} Customer Content Services - -