From c34709490f816a3880789ae7a836f0c26d588f88 Mon Sep 17 00:00:00 2001 From: jmagak Date: Fri, 18 Oct 2024 14:20:52 +0200 Subject: [PATCH 1/9] Adds benefits of RHDH module --- modules/discover/con_benefits-of-rhdh.adoc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 modules/discover/con_benefits-of-rhdh.adoc diff --git a/modules/discover/con_benefits-of-rhdh.adoc b/modules/discover/con_benefits-of-rhdh.adoc new file mode 100644 index 0000000000..2fffb0557d --- /dev/null +++ b/modules/discover/con_benefits-of-rhdh.adoc @@ -0,0 +1,21 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-10-18 + +:_mod-docs-content-type: CONCEPT + +[id="benefits-of-rhdh_{context}"] += Benefits of {product} + +{product} is designed to streamline developer workflow by providing a consistent self-service experience and can simplify application development through pre-built resources and enhanced collaboration tools. The following are the benefits of {product}: + +* Increased developer productivity. Increases productivity by eliminating common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications. + +* Unified self-service dashboard. Provides development teams with a unified dashboard covering various aspects such as Git, CI/CD, SAST/DAST, Supply Chain, OpenShift/Kubernetes cluster, JIRA, monitoring, API, documentation, and more, facilitated by over 150 plugins. All curated by a platform engineering team, aligning with the company’s best practices. + +* Best practices through software templates. Automates organizational best practices by encoding common tasks such as creating new applications, running Ansible jobs, and establishing CI/CD pipelines for production deployment in Git. + +* Scalable technical documentation. Code and documentation resides in the same repository, eliminating dependencies on proprietary document systems. + +* Efficient onboarding for new developers. New developers can adapt quickly and become productive within a short timeframe. + +* Robust enterprise Role-Based Access Control (RBAC). Empowers administrators to create roles, assign users or groups to roles, and implement robust security policies for enhanced access control. \ No newline at end of file From 776d2f7df079a3d2c9b47c928b544532983b47e3 Mon Sep 17 00:00:00 2001 From: jmagak Date: Sat, 12 Oct 2024 00:53:56 +0200 Subject: [PATCH 2/9] modifies about section --- assemblies/assembly_about-rhdh.adoc | 28 ++++++++++++ assemblies/assembly_benefits-of-rhdh.adoc | 30 +++++++++++++ ...assembly_sizing-requirements-for-rhdh.adoc | 45 +++++++++++++++++++ titles/discover/artifacts | 1 + titles/discover/assemblies | 1 + titles/discover/docinfo.xml | 11 +++++ titles/discover/images | 1 + titles/discover/master.adoc | 16 +++++++ titles/discover/modules | 1 + 9 files changed, 134 insertions(+) create mode 100644 assemblies/assembly_about-rhdh.adoc create mode 100644 assemblies/assembly_benefits-of-rhdh.adoc create mode 100644 assemblies/assembly_sizing-requirements-for-rhdh.adoc create mode 120000 titles/discover/artifacts create mode 120000 titles/discover/assemblies create mode 100644 titles/discover/docinfo.xml create mode 120000 titles/discover/images create mode 100644 titles/discover/master.adoc create mode 120000 titles/discover/modules diff --git a/assemblies/assembly_about-rhdh.adoc b/assemblies/assembly_about-rhdh.adoc new file mode 100644 index 0000000000..a7b02d13b5 --- /dev/null +++ b/assemblies/assembly_about-rhdh.adoc @@ -0,0 +1,28 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-10-07 + +ifdef::context[:parent-context-of-about-rhdh: {context}] + +:_mod-docs-content-type: ASSEMBLY + +ifndef::context[] +[id="about-rhdh"] +endif::[] +ifdef::context[] +[id="about-rhdh_{context}"] +endif::[] += About rhdh + +:context: about-rhdh + +{product} is a fully supported, 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 productivity. {product} simplifies decision-making by providing a developer experience that presents a selection of internally approved tools, programming languages, and developer resources within a self-managed portal. 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. + + + +include::assemblies/assembly_benefits-of-rhdh.adoc[leveloffset=+1] + +include::assemblies/assembly_sizing-requirements-for-rhdh.adoc[leveloffset=+1] + + + + diff --git a/assemblies/assembly_benefits-of-rhdh.adoc b/assemblies/assembly_benefits-of-rhdh.adoc new file mode 100644 index 0000000000..0f60905f9e --- /dev/null +++ b/assemblies/assembly_benefits-of-rhdh.adoc @@ -0,0 +1,30 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-10-11 + +ifdef::context[:parent-context-of-benefits-of-rhdh: {context}] + +:_mod-docs-content-type: ASSEMBLY + +ifndef::context[] +[id="benefits-of-rhdh"] +endif::[] +ifdef::context[] +[id="benefits-of-rhdh_{context}"] +endif::[] += Benefits of {product} + +:context: benefits-of-rhdh + +{product} streamlines developer workflow by providing a consistent self-service experience and simplifies application development through pre-built resources and enhanced collaboration tools. The following are the benefits of {product}: + +* Increased developer productivity. Increases productivity by eliminating common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications. + +* Unified self-service dashboard. Provides development teams with a unified dashboard covering various aspects such as Git, CI/CD, SAST/DAST, Supply Chain, OpenShift/Kubernetes cluster, JIRA, monitoring, API, documentation, and more, facilitated by over 150 plugins. All curated by a platform engineering team, aligning with the company’s best practices. + +* Best practices through software templates. Automates organizational best practices by encoding common tasks such as creating new applications, running Ansible jobs, and establishing CI/CD pipelines for production deployment in Git. + +* Scalable technical documentation. Code and documentation resides in the same repository, eliminating dependencies on proprietary document systems. + +* Efficient onboarding for new developers. New developers quickly adapt and become productive within a short timeframe. + +* Robust enterprise Role-Based Access Control (RBAC). Empowers administrators to create roles, assign users or groups to roles, and implement robust security policies for enhanced access control. \ No newline at end of file diff --git a/assemblies/assembly_sizing-requirements-for-rhdh.adoc b/assemblies/assembly_sizing-requirements-for-rhdh.adoc new file mode 100644 index 0000000000..713ca8fa2c --- /dev/null +++ b/assemblies/assembly_sizing-requirements-for-rhdh.adoc @@ -0,0 +1,45 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-10-11 + +ifdef::context[:parent-context-of-sizing-requirements-for-rhdh: {context}] + +:_mod-docs-content-type: ASSEMBLY + +ifndef::context[] +[id="sizing-requirements-for-rhdh"] +endif::[] +ifdef::context[] +[id="sizing-requirements-for-rhdh_{context}"] +endif::[] += Sizing requirements for {product} + +:context: sizing-requirements-for-rhdh + +Scalability of {product} requires significant resource allocation. The following table lists the sizing requirements for installing and running {product}, including both the {product-short} application and {product-short} database components. + +.Recommended sizing for running {product} +|=== +| Components | {product} application | {product} database + +| Central Processing Unit (CPU) +| 4 vCPU +| 2 vCPU + +| Memory +| 16 GB +| 8 GB + +| Storage size +| 2 GB +| 20 GB + +| Replicas +| 2 or more +| 3 or more +|=== + + +[role="_additional-resources"] +.Additional resources + +* For more information about various features of {product} and how you can extend the upstream Backstage product by providing additional features such as integration with OpenShift, enterprise role-based access control (RBAC), and dynamic plugins, see link:https://developers.redhat.com/rhdh/overview?intcmp=7015Y000003swEuQAI&source=sso[{product}]. diff --git a/titles/discover/artifacts b/titles/discover/artifacts new file mode 120000 index 0000000000..f30b6dea60 --- /dev/null +++ b/titles/discover/artifacts @@ -0,0 +1 @@ +../../artifacts \ No newline at end of file diff --git a/titles/discover/assemblies b/titles/discover/assemblies new file mode 120000 index 0000000000..91646274db --- /dev/null +++ b/titles/discover/assemblies @@ -0,0 +1 @@ +../../assemblies \ No newline at end of file diff --git a/titles/discover/docinfo.xml b/titles/discover/docinfo.xml new file mode 100644 index 0000000000..5f7fe2ebac --- /dev/null +++ b/titles/discover/docinfo.xml @@ -0,0 +1,11 @@ +{title} +{product} +{product-version} +{subtitle} + + {abstract} + + + {company-name} Customer Content Services + + diff --git a/titles/discover/images b/titles/discover/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/discover/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/discover/master.adoc b/titles/discover/master.adoc new file mode 100644 index 0000000000..a5e15b34c8 --- /dev/null +++ b/titles/discover/master.adoc @@ -0,0 +1,16 @@ +include::artifacts/attributes.adoc[] +:context: title-discover +:doctype: book +:imagesdir: images +:title: About +:subtitle: Introduction to {product} +:abstract: {product} is an enterprise-grade platform for building developer portals. As an administrative user, you can manage roles and permissions of other users and configure {product-short} to meet the specific needs of your organization. + +//[id="{context}"] +//= {title} + +//{abstract} + +include::assemblies/assembly_about-rhdh.adoc[] + + diff --git a/titles/discover/modules b/titles/discover/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/titles/discover/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file From e47b9c4314f2685912fba347c5a184e405a8d3b9 Mon Sep 17 00:00:00 2001 From: jmagak Date: Mon, 14 Oct 2024 14:21:30 +0200 Subject: [PATCH 3/9] modifies about section --- assemblies/assembly_about-rhdh.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/assemblies/assembly_about-rhdh.adoc b/assemblies/assembly_about-rhdh.adoc index a7b02d13b5..2e064e88fa 100644 --- a/assemblies/assembly_about-rhdh.adoc +++ b/assemblies/assembly_about-rhdh.adoc @@ -19,10 +19,10 @@ endif::[] -include::assemblies/assembly_benefits-of-rhdh.adoc[leveloffset=+1] +include::assembly_benefits-of-rhdh.adoc[leveloffset=+1] -include::assemblies/assembly_sizing-requirements-for-rhdh.adoc[leveloffset=+1] +include::assembly_sizing-requirements-for-rhdh.adoc[leveloffset=+1] From 7936ca55795f39bae33d442c5ad1028e319a2715 Mon Sep 17 00:00:00 2001 From: jmagak Date: Wed, 16 Oct 2024 12:32:14 +0200 Subject: [PATCH 4/9] Modifies the section --- assemblies/assembly_about-rhdh.adoc | 28 ------------ assemblies/assembly_benefits-of-rhdh.adoc | 30 ------------- ...assembly_sizing-requirements-for-rhdh.adoc | 45 ------------------- modules/discover/con_benefits-of-rhdh.adoc | 21 --------- titles/discover/artifacts | 1 - titles/discover/assemblies | 1 - titles/discover/docinfo.xml | 11 ----- titles/discover/images | 1 - titles/discover/master.adoc | 16 ------- titles/discover/modules | 1 - 10 files changed, 155 deletions(-) delete mode 100644 assemblies/assembly_about-rhdh.adoc delete mode 100644 assemblies/assembly_benefits-of-rhdh.adoc delete mode 100644 assemblies/assembly_sizing-requirements-for-rhdh.adoc delete mode 100644 modules/discover/con_benefits-of-rhdh.adoc delete mode 120000 titles/discover/artifacts delete mode 120000 titles/discover/assemblies delete mode 100644 titles/discover/docinfo.xml delete mode 120000 titles/discover/images delete mode 100644 titles/discover/master.adoc delete mode 120000 titles/discover/modules diff --git a/assemblies/assembly_about-rhdh.adoc b/assemblies/assembly_about-rhdh.adoc deleted file mode 100644 index 2e064e88fa..0000000000 --- a/assemblies/assembly_about-rhdh.adoc +++ /dev/null @@ -1,28 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2024-10-07 - -ifdef::context[:parent-context-of-about-rhdh: {context}] - -:_mod-docs-content-type: ASSEMBLY - -ifndef::context[] -[id="about-rhdh"] -endif::[] -ifdef::context[] -[id="about-rhdh_{context}"] -endif::[] -= About rhdh - -:context: about-rhdh - -{product} is a fully supported, 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 productivity. {product} simplifies decision-making by providing a developer experience that presents a selection of internally approved tools, programming languages, and developer resources within a self-managed portal. 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. - - - -include::assembly_benefits-of-rhdh.adoc[leveloffset=+1] - - -include::assembly_sizing-requirements-for-rhdh.adoc[leveloffset=+1] - - - diff --git a/assemblies/assembly_benefits-of-rhdh.adoc b/assemblies/assembly_benefits-of-rhdh.adoc deleted file mode 100644 index 0f60905f9e..0000000000 --- a/assemblies/assembly_benefits-of-rhdh.adoc +++ /dev/null @@ -1,30 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2024-10-11 - -ifdef::context[:parent-context-of-benefits-of-rhdh: {context}] - -:_mod-docs-content-type: ASSEMBLY - -ifndef::context[] -[id="benefits-of-rhdh"] -endif::[] -ifdef::context[] -[id="benefits-of-rhdh_{context}"] -endif::[] -= Benefits of {product} - -:context: benefits-of-rhdh - -{product} streamlines developer workflow by providing a consistent self-service experience and simplifies application development through pre-built resources and enhanced collaboration tools. The following are the benefits of {product}: - -* Increased developer productivity. Increases productivity by eliminating common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications. - -* Unified self-service dashboard. Provides development teams with a unified dashboard covering various aspects such as Git, CI/CD, SAST/DAST, Supply Chain, OpenShift/Kubernetes cluster, JIRA, monitoring, API, documentation, and more, facilitated by over 150 plugins. All curated by a platform engineering team, aligning with the company’s best practices. - -* Best practices through software templates. Automates organizational best practices by encoding common tasks such as creating new applications, running Ansible jobs, and establishing CI/CD pipelines for production deployment in Git. - -* Scalable technical documentation. Code and documentation resides in the same repository, eliminating dependencies on proprietary document systems. - -* Efficient onboarding for new developers. New developers quickly adapt and become productive within a short timeframe. - -* Robust enterprise Role-Based Access Control (RBAC). Empowers administrators to create roles, assign users or groups to roles, and implement robust security policies for enhanced access control. \ No newline at end of file diff --git a/assemblies/assembly_sizing-requirements-for-rhdh.adoc b/assemblies/assembly_sizing-requirements-for-rhdh.adoc deleted file mode 100644 index 713ca8fa2c..0000000000 --- a/assemblies/assembly_sizing-requirements-for-rhdh.adoc +++ /dev/null @@ -1,45 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2024-10-11 - -ifdef::context[:parent-context-of-sizing-requirements-for-rhdh: {context}] - -:_mod-docs-content-type: ASSEMBLY - -ifndef::context[] -[id="sizing-requirements-for-rhdh"] -endif::[] -ifdef::context[] -[id="sizing-requirements-for-rhdh_{context}"] -endif::[] -= Sizing requirements for {product} - -:context: sizing-requirements-for-rhdh - -Scalability of {product} requires significant resource allocation. The following table lists the sizing requirements for installing and running {product}, including both the {product-short} application and {product-short} database components. - -.Recommended sizing for running {product} -|=== -| Components | {product} application | {product} database - -| Central Processing Unit (CPU) -| 4 vCPU -| 2 vCPU - -| Memory -| 16 GB -| 8 GB - -| Storage size -| 2 GB -| 20 GB - -| Replicas -| 2 or more -| 3 or more -|=== - - -[role="_additional-resources"] -.Additional resources - -* For more information about various features of {product} and how you can extend the upstream Backstage product by providing additional features such as integration with OpenShift, enterprise role-based access control (RBAC), and dynamic plugins, see link:https://developers.redhat.com/rhdh/overview?intcmp=7015Y000003swEuQAI&source=sso[{product}]. diff --git a/modules/discover/con_benefits-of-rhdh.adoc b/modules/discover/con_benefits-of-rhdh.adoc deleted file mode 100644 index 2fffb0557d..0000000000 --- a/modules/discover/con_benefits-of-rhdh.adoc +++ /dev/null @@ -1,21 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2024-10-18 - -:_mod-docs-content-type: CONCEPT - -[id="benefits-of-rhdh_{context}"] -= Benefits of {product} - -{product} is designed to streamline developer workflow by providing a consistent self-service experience and can simplify application development through pre-built resources and enhanced collaboration tools. The following are the benefits of {product}: - -* Increased developer productivity. Increases productivity by eliminating common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications. - -* Unified self-service dashboard. Provides development teams with a unified dashboard covering various aspects such as Git, CI/CD, SAST/DAST, Supply Chain, OpenShift/Kubernetes cluster, JIRA, monitoring, API, documentation, and more, facilitated by over 150 plugins. All curated by a platform engineering team, aligning with the company’s best practices. - -* Best practices through software templates. Automates organizational best practices by encoding common tasks such as creating new applications, running Ansible jobs, and establishing CI/CD pipelines for production deployment in Git. - -* Scalable technical documentation. Code and documentation resides in the same repository, eliminating dependencies on proprietary document systems. - -* Efficient onboarding for new developers. New developers can adapt quickly and become productive within a short timeframe. - -* Robust enterprise Role-Based Access Control (RBAC). Empowers administrators to create roles, assign users or groups to roles, and implement robust security policies for enhanced access control. \ No newline at end of file diff --git a/titles/discover/artifacts b/titles/discover/artifacts deleted file mode 120000 index f30b6dea60..0000000000 --- a/titles/discover/artifacts +++ /dev/null @@ -1 +0,0 @@ -../../artifacts \ No newline at end of file diff --git a/titles/discover/assemblies b/titles/discover/assemblies deleted file mode 120000 index 91646274db..0000000000 --- a/titles/discover/assemblies +++ /dev/null @@ -1 +0,0 @@ -../../assemblies \ No newline at end of file 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 - - diff --git a/titles/discover/images b/titles/discover/images deleted file mode 120000 index 5fa6987088..0000000000 --- a/titles/discover/images +++ /dev/null @@ -1 +0,0 @@ -../../images \ No newline at end of file diff --git a/titles/discover/master.adoc b/titles/discover/master.adoc deleted file mode 100644 index a5e15b34c8..0000000000 --- a/titles/discover/master.adoc +++ /dev/null @@ -1,16 +0,0 @@ -include::artifacts/attributes.adoc[] -:context: title-discover -:doctype: book -:imagesdir: images -:title: About -:subtitle: Introduction to {product} -:abstract: {product} is an enterprise-grade platform for building developer portals. As an administrative user, you can manage roles and permissions of other users and configure {product-short} to meet the specific needs of your organization. - -//[id="{context}"] -//= {title} - -//{abstract} - -include::assemblies/assembly_about-rhdh.adoc[] - - diff --git a/titles/discover/modules b/titles/discover/modules deleted file mode 120000 index 36719b9de7..0000000000 --- a/titles/discover/modules +++ /dev/null @@ -1 +0,0 @@ -../../modules/ \ No newline at end of file From 4290dc34eb31934a7e8884ae94b48d1b1a6ced63 Mon Sep 17 00:00:00 2001 From: jmagak Date: Fri, 18 Oct 2024 14:20:52 +0200 Subject: [PATCH 5/9] Adds benefits of RHDH module --- modules/discover/con_benefits-of-rhdh.adoc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 modules/discover/con_benefits-of-rhdh.adoc diff --git a/modules/discover/con_benefits-of-rhdh.adoc b/modules/discover/con_benefits-of-rhdh.adoc new file mode 100644 index 0000000000..2fffb0557d --- /dev/null +++ b/modules/discover/con_benefits-of-rhdh.adoc @@ -0,0 +1,21 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-10-18 + +:_mod-docs-content-type: CONCEPT + +[id="benefits-of-rhdh_{context}"] += Benefits of {product} + +{product} is designed to streamline developer workflow by providing a consistent self-service experience and can simplify application development through pre-built resources and enhanced collaboration tools. The following are the benefits of {product}: + +* Increased developer productivity. Increases productivity by eliminating common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications. + +* Unified self-service dashboard. Provides development teams with a unified dashboard covering various aspects such as Git, CI/CD, SAST/DAST, Supply Chain, OpenShift/Kubernetes cluster, JIRA, monitoring, API, documentation, and more, facilitated by over 150 plugins. All curated by a platform engineering team, aligning with the company’s best practices. + +* Best practices through software templates. Automates organizational best practices by encoding common tasks such as creating new applications, running Ansible jobs, and establishing CI/CD pipelines for production deployment in Git. + +* Scalable technical documentation. Code and documentation resides in the same repository, eliminating dependencies on proprietary document systems. + +* Efficient onboarding for new developers. New developers can adapt quickly and become productive within a short timeframe. + +* Robust enterprise Role-Based Access Control (RBAC). Empowers administrators to create roles, assign users or groups to roles, and implement robust security policies for enhanced access control. \ No newline at end of file From fb896218d33a0effc6cbef671f9340d444fba97d Mon Sep 17 00:00:00 2001 From: jmagak Date: Fri, 18 Oct 2024 14:37:18 +0200 Subject: [PATCH 6/9] Updates the branch with latest changes All Conflicts: --- modules/discover/con_benefits-of-rhdh.adoc | 21 ---------- modules/installation/con-rhdh-overview.adoc | 12 ------ .../con-release-notes-overview.adoc | 40 ------------------- .../title-getting-started.adoc | 3 -- .../title-rhdh-release-notes.adoc | 4 -- 5 files changed, 80 deletions(-) delete mode 100644 modules/discover/con_benefits-of-rhdh.adoc delete mode 100644 modules/installation/con-rhdh-overview.adoc delete mode 100644 modules/release-notes/con-release-notes-overview.adoc diff --git a/modules/discover/con_benefits-of-rhdh.adoc b/modules/discover/con_benefits-of-rhdh.adoc deleted file mode 100644 index 2fffb0557d..0000000000 --- a/modules/discover/con_benefits-of-rhdh.adoc +++ /dev/null @@ -1,21 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2024-10-18 - -:_mod-docs-content-type: CONCEPT - -[id="benefits-of-rhdh_{context}"] -= Benefits of {product} - -{product} is designed to streamline developer workflow by providing a consistent self-service experience and can simplify application development through pre-built resources and enhanced collaboration tools. The following are the benefits of {product}: - -* Increased developer productivity. Increases productivity by eliminating common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications. - -* Unified self-service dashboard. Provides development teams with a unified dashboard covering various aspects such as Git, CI/CD, SAST/DAST, Supply Chain, OpenShift/Kubernetes cluster, JIRA, monitoring, API, documentation, and more, facilitated by over 150 plugins. All curated by a platform engineering team, aligning with the company’s best practices. - -* Best practices through software templates. Automates organizational best practices by encoding common tasks such as creating new applications, running Ansible jobs, and establishing CI/CD pipelines for production deployment in Git. - -* Scalable technical documentation. Code and documentation resides in the same repository, eliminating dependencies on proprietary document systems. - -* Efficient onboarding for new developers. New developers can adapt quickly and become productive within a short timeframe. - -* Robust enterprise Role-Based Access Control (RBAC). Empowers administrators to create roles, assign users or groups to roles, and implement robust security policies for enhanced access control. \ No newline at end of file diff --git a/modules/installation/con-rhdh-overview.adoc b/modules/installation/con-rhdh-overview.adoc deleted file mode 100644 index 8145955513..0000000000 --- a/modules/installation/con-rhdh-overview.adoc +++ /dev/null @@ -1,12 +0,0 @@ -[id='con-rhdh-overview_{context}'] -= Overview of {product} - -{product} ({product-short}) serves as an open developer platform designed for building developer portals and is based on the link:https://backstage.io/[backstage] project. Using {product-short}, the engineering teams can access a unified platform that streamlines the development process and provides a variety of tools and resources to build high-quality software efficiently. - -The goal of {product-short} is to address the difficulties associated with creating and sustaining developer portals using: - -* A centralized dashboard to view all available developer tools and resources to increase productivity -* Self-service capabilities, along with guardrails, for cloud-native application development that complies with enterprise-class best practices -* Proper security and governance for all developers across the enterprise - -The {product} simplifies decision-making by providing a developer experience that presents a selection of internally approved tools, programming languages, and various developer resources within a self-managed portal. This approach contributes to the acceleration of application development and the maintenance of code quality, all while fostering innovation. diff --git a/modules/release-notes/con-release-notes-overview.adoc b/modules/release-notes/con-release-notes-overview.adoc deleted file mode 100644 index 772a366cdd..0000000000 --- a/modules/release-notes/con-release-notes-overview.adoc +++ /dev/null @@ -1,40 +0,0 @@ -[id='con-release-notes-overview_{context}'] -= About this release - -The release notes provide high-level coverage of the features that have been implemented in {product} {product-version} and document known issues in this release. - -Some features within this release may be available as a Technology Preview, providing access to upcoming product features, enabling customers to test functionality and to provide feedback during the development process. - -For more information about the support scope of Red Hat Technology Preview features, read https://access.redhat.com/support/offerings/techpreview[Technology Preview Support Scope]. - -Benefits of {product} include: - -* *Increased developer productivity*: Increases productivity by eliminating common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications. -* *Unified self-service dashboard*: Provides development teams with a unified dashboard covering various aspects such as Git, CI/CD, SAST/DAST, Supply Chain, OpenShift/Kubernetes cluster, JIRA, monitoring, API, documentation, and more, facilitated by over 150 plugins. All curated by a platform engineering team, aligning with the company's best practices. -* *Best practices through software templates*: Automates organizational best practices by encoding common tasks such as creating new applications, running Ansible jobs, and establishing CI/CD pipelines for production deployment in Git. -* *Scalable technical documentation*: Code and documentation resides in the same repository, eliminating dependencies on proprietary document systems. -* *Efficient onboarding for new developers*: New developers quickly adapt and become productive within a short timeframe. -* *Robust enterprise Role-Based Access Control (RBAC)*: Empowers administrators to create roles, assign users or groups to roles, and implement robust security policies for enhanced access control. - -.Additional resources - -* link:{upgrading-book-url}[{upgrading-book-title}]. - -== Supported Platforms - -{product} runs on {ocp-short} {ocp-version-min}-{ocp-version} on the following CPU architecture: - -* AMD64 and Intel 64 (`x86_64`) - -In addition to {ocp-short}, the following hosted environments are also supported: - -* {eks-brand-name} -* {aks-brand-name} -* {osd-short} on {gcp-brand-name} - -.Additional resources - -* link:https://docs.redhat.com/en/documentation/openshift_container_platform[OpenShift documentation] -* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}#Install%20and%20Upgrade[{product} Installation guides] - - diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc index 2dd9520f55..f6cda7b944 100644 --- a/titles/getting-started-rhdh/title-getting-started.adoc +++ b/titles/getting-started-rhdh/title-getting-started.adoc @@ -10,9 +10,6 @@ As a developer, you can use {product} to experience a streamlined development en //customer support links include::artifacts/snip-customer-support-info.adoc[] -// rhdh overview -include::modules/installation/con-rhdh-overview.adoc[leveloffset=+1] - // Sizing include::modules/getting-started/ref-rhdh-sizing.adoc[leveloffset=+1] diff --git a/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc b/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc index 2d9a1fd33d..9e0af92bd0 100644 --- a/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc +++ b/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc @@ -12,10 +12,6 @@ include::artifacts/attributes.adoc[] //customer support links include::artifacts/snip-customer-support-info.adoc[] -//includes -include::modules/release-notes/con-release-notes-overview.adoc[leveloffset=+1] - - include::assemblies/assembly-release-notes-new-features.adoc[leveloffset=+1] From f5e0c35ae2e6ee9ad362e6e7517a3ccb38af6283 Mon Sep 17 00:00:00 2001 From: jmagak Date: Fri, 18 Oct 2024 16:16:50 +0200 Subject: [PATCH 7/9] Updates the branch --- assemblies/assembly_about-rhdh.adoc | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 assemblies/assembly_about-rhdh.adoc diff --git a/assemblies/assembly_about-rhdh.adoc b/assemblies/assembly_about-rhdh.adoc new file mode 100644 index 0000000000..abdd7c203a --- /dev/null +++ b/assemblies/assembly_about-rhdh.adoc @@ -0,0 +1,22 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-10-07 + +ifdef::context[:parent-context-of-about-rhdh: {context}] + +:_mod-docs-content-type: ASSEMBLY + +ifndef::context[] +[id="about-rhdh"] +endif::[] +ifdef::context[] +[id="about-rhdh_{context}"] +endif::[] += About {product} + +:context: about-rhdh + +{product} is a fully supported, 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 productivity. {product} simplifies decision-making by providing a developer experience that presents a selection of internally approved tools, programming languages, and developer resources within a self-managed portal. 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. + +include::modules/discover/con_benefits-of-rhdh.adoc[leveloffset=+1] + + From eb25967089862541d0c7fd10a4bd44e8a677ff45 Mon Sep 17 00:00:00 2001 From: jmagak Date: Mon, 25 Nov 2024 09:51:08 +0100 Subject: [PATCH 8/9] Updates branch --- assemblies/assembly_about-rhdh.adoc | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 assemblies/assembly_about-rhdh.adoc diff --git a/assemblies/assembly_about-rhdh.adoc b/assemblies/assembly_about-rhdh.adoc deleted file mode 100644 index abdd7c203a..0000000000 --- a/assemblies/assembly_about-rhdh.adoc +++ /dev/null @@ -1,22 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2024-10-07 - -ifdef::context[:parent-context-of-about-rhdh: {context}] - -:_mod-docs-content-type: ASSEMBLY - -ifndef::context[] -[id="about-rhdh"] -endif::[] -ifdef::context[] -[id="about-rhdh_{context}"] -endif::[] -= About {product} - -:context: about-rhdh - -{product} is a fully supported, 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 productivity. {product} simplifies decision-making by providing a developer experience that presents a selection of internally approved tools, programming languages, and developer resources within a self-managed portal. 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. - -include::modules/discover/con_benefits-of-rhdh.adoc[leveloffset=+1] - - From f38f765c05b89af29db50defa790e2969960b8d3 Mon Sep 17 00:00:00 2001 From: jmagak Date: Mon, 25 Nov 2024 19:33:26 +0100 Subject: [PATCH 9/9] Removes existing content --- modules/getting-started/ref-rhdh-sizing.adoc | 33 ------------------- .../title-getting-started.adoc | 3 -- 2 files changed, 36 deletions(-) delete mode 100644 modules/getting-started/ref-rhdh-sizing.adoc diff --git a/modules/getting-started/ref-rhdh-sizing.adoc b/modules/getting-started/ref-rhdh-sizing.adoc deleted file mode 100644 index d236bc76a1..0000000000 --- a/modules/getting-started/ref-rhdh-sizing.adoc +++ /dev/null @@ -1,33 +0,0 @@ -[id='ref-rhdh-sizing_{context}'] -= Sizing requirements for {product} - -Scalability of {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 -|=== \ No newline at end of file diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc index f6cda7b944..6ea39318b0 100644 --- a/titles/getting-started-rhdh/title-getting-started.adoc +++ b/titles/getting-started-rhdh/title-getting-started.adoc @@ -10,9 +10,6 @@ As a developer, you can use {product} to experience a streamlined development en //customer support links include::artifacts/snip-customer-support-info.adoc[] -// Sizing -include::modules/getting-started/ref-rhdh-sizing.adoc[leveloffset=+1] - // 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]