From a83f56ff66457b47ac570e5df70845bc85e6b6e4 Mon Sep 17 00:00:00 2001 From: jmagak Date: Tue, 5 Nov 2024 00:21:14 +0100 Subject: [PATCH 1/7] Adds benefits of rhdh --- ...out-rhdh.adoc => assembly-about-rhdh.adoc} | 8 +++++++ modules/discover/con-benefits-of-rhdh.adoc | 21 +++++++++++++++++++ titles/discover/master.adoc | 2 +- 3 files changed, 30 insertions(+), 1 deletion(-) rename assemblies/{assembly_about-rhdh.adoc => assembly-about-rhdh.adoc} (84%) create mode 100644 modules/discover/con-benefits-of-rhdh.adoc diff --git a/assemblies/assembly_about-rhdh.adoc b/assemblies/assembly-about-rhdh.adoc similarity index 84% rename from assemblies/assembly_about-rhdh.adoc rename to assemblies/assembly-about-rhdh.adoc index 5baa37ff98..e65726fed1 100644 --- a/assemblies/assembly_about-rhdh.adoc +++ b/assemblies/assembly-about-rhdh.adoc @@ -1,3 +1,9 @@ +<<<<<<< HEAD +======= +:_newdoc-version: 2.18.3 +:_template-generated: 2024-11-04 + +>>>>>>> 533d1804 (Adds benefits of rhdh) ifdef::context[:parent-context-of-about-rhdh: {context}] :_mod-docs-content-type: ASSEMBLY @@ -14,3 +20,5 @@ endif::[] {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] diff --git a/modules/discover/con-benefits-of-rhdh.adoc b/modules/discover/con-benefits-of-rhdh.adoc new file mode 100644 index 0000000000..bd3685fd5a --- /dev/null +++ b/modules/discover/con-benefits-of-rhdh.adoc @@ -0,0 +1,21 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-11-04 + +:_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, Continuous Integration/Continuous Delivery (CI/CD), Static Application Security Testing (SAST)/Dynamic Application Security Testing (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 is 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 time frame. +* 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. + +[role="_additional-resources"] +.Additional resources +* For more information about the different 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[Overview of {product}]. \ No newline at end of file diff --git a/titles/discover/master.adoc b/titles/discover/master.adoc index 961e87c940..55147faff6 100644 --- a/titles/discover/master.adoc +++ b/titles/discover/master.adoc @@ -11,4 +11,4 @@ include::artifacts/attributes.adoc[] //{abstract} -include::assemblies/assembly_about-rhdh.adoc[] +include::assemblies/assembly-about-rhdh.adoc[] From 182a71e37f7f4ade7ff933b55015a41d1d3a1b2d Mon Sep 17 00:00:00 2001 From: jmagak Date: Tue, 5 Nov 2024 00:25:54 +0100 Subject: [PATCH 2/7] Adds benefits of rhdh --- assemblies/assembly-about-rhdh.adoc | 7 +++++++ titles/discover/master.adoc | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/assemblies/assembly-about-rhdh.adoc b/assemblies/assembly-about-rhdh.adoc index e65726fed1..6646f3f1cd 100644 --- a/assemblies/assembly-about-rhdh.adoc +++ b/assemblies/assembly-about-rhdh.adoc @@ -1,9 +1,12 @@ <<<<<<< HEAD +<<<<<<< HEAD ======= :_newdoc-version: 2.18.3 :_template-generated: 2024-11-04 >>>>>>> 533d1804 (Adds benefits of rhdh) +======= +>>>>>>> 06f2b9fb (Adds benefits of rhdh) ifdef::context[:parent-context-of-about-rhdh: {context}] :_mod-docs-content-type: ASSEMBLY @@ -20,5 +23,9 @@ endif::[] {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. +<<<<<<< HEAD include::modules/discover/con-benefits-of-rhdh.adoc[leveloffset=+1] +======= +include::modules/discover/con-benefits-of-rhdh.adoc[leveloffset=+1] +>>>>>>> 06f2b9fb (Adds benefits of rhdh) diff --git a/titles/discover/master.adoc b/titles/discover/master.adoc index 55147faff6..7bab16bb40 100644 --- a/titles/discover/master.adoc +++ b/titles/discover/master.adoc @@ -11,4 +11,8 @@ include::artifacts/attributes.adoc[] //{abstract} +<<<<<<< HEAD include::assemblies/assembly-about-rhdh.adoc[] +======= +include::assemblies/assembly-about-rhdh.adoc[] +>>>>>>> 06f2b9fb (Adds benefits of rhdh) From 311b83936e492d8c332851efa493c7d580f3deda Mon Sep 17 00:00:00 2001 From: jmagak Date: Tue, 5 Nov 2024 00:36:39 +0100 Subject: [PATCH 3/7] Adds benefits of rhdh --- assemblies/assembly-about-rhdh.adoc | 4 ---- titles/discover/master.adoc | 4 ---- 2 files changed, 8 deletions(-) diff --git a/assemblies/assembly-about-rhdh.adoc b/assemblies/assembly-about-rhdh.adoc index 6646f3f1cd..1da22d0963 100644 --- a/assemblies/assembly-about-rhdh.adoc +++ b/assemblies/assembly-about-rhdh.adoc @@ -23,9 +23,5 @@ endif::[] {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. -<<<<<<< HEAD include::modules/discover/con-benefits-of-rhdh.adoc[leveloffset=+1] -======= -include::modules/discover/con-benefits-of-rhdh.adoc[leveloffset=+1] ->>>>>>> 06f2b9fb (Adds benefits of rhdh) diff --git a/titles/discover/master.adoc b/titles/discover/master.adoc index 7bab16bb40..55147faff6 100644 --- a/titles/discover/master.adoc +++ b/titles/discover/master.adoc @@ -11,8 +11,4 @@ include::artifacts/attributes.adoc[] //{abstract} -<<<<<<< HEAD include::assemblies/assembly-about-rhdh.adoc[] -======= -include::assemblies/assembly-about-rhdh.adoc[] ->>>>>>> 06f2b9fb (Adds benefits of rhdh) From e26cd6c3f550edbea3655e0133d40a02494afd28 Mon Sep 17 00:00:00 2001 From: jmagak Date: Tue, 5 Nov 2024 00:42:29 +0100 Subject: [PATCH 4/7] Adds benefits of rhdh --- assemblies/assembly-about-rhdh.adoc | 9 --------- modules/discover/con-benefits-of-rhdh.adoc | 3 --- 2 files changed, 12 deletions(-) diff --git a/assemblies/assembly-about-rhdh.adoc b/assemblies/assembly-about-rhdh.adoc index 1da22d0963..60a23a124a 100644 --- a/assemblies/assembly-about-rhdh.adoc +++ b/assemblies/assembly-about-rhdh.adoc @@ -1,12 +1,3 @@ -<<<<<<< HEAD -<<<<<<< HEAD -======= -:_newdoc-version: 2.18.3 -:_template-generated: 2024-11-04 - ->>>>>>> 533d1804 (Adds benefits of rhdh) -======= ->>>>>>> 06f2b9fb (Adds benefits of rhdh) ifdef::context[:parent-context-of-about-rhdh: {context}] :_mod-docs-content-type: ASSEMBLY diff --git a/modules/discover/con-benefits-of-rhdh.adoc b/modules/discover/con-benefits-of-rhdh.adoc index bd3685fd5a..a311ef00b0 100644 --- a/modules/discover/con-benefits-of-rhdh.adoc +++ b/modules/discover/con-benefits-of-rhdh.adoc @@ -1,6 +1,3 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2024-11-04 - :_mod-docs-content-type: CONCEPT [id="benefits-of-rhdh_{context}"] From 42f99277e344e4aa9a7fac02bb1e580bb46c3251 Mon Sep 17 00:00:00 2001 From: jmagak Date: Tue, 5 Nov 2024 17:44:01 +0100 Subject: [PATCH 5/7] Adds benefits of rhdh --- assemblies/assembly-about-rhdh.adoc | 6 ++- modules/discover/con-benefits-of-rhdh.adoc | 49 +++++++++++++++++----- 2 files changed, 44 insertions(+), 11 deletions(-) diff --git a/assemblies/assembly-about-rhdh.adoc b/assemblies/assembly-about-rhdh.adoc index 60a23a124a..d6cf246a86 100644 --- a/assemblies/assembly-about-rhdh.adoc +++ b/assemblies/assembly-about-rhdh.adoc @@ -12,7 +12,11 @@ endif::[] :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. +{product} is a fully supported, open developer platform that reduces friction and frustration of developers while boosting productivity. + +This platform is driven by a centralized software catalog, providing efficiency to your microservices and infrastructure. + +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] diff --git a/modules/discover/con-benefits-of-rhdh.adoc b/modules/discover/con-benefits-of-rhdh.adoc index a311ef00b0..dc94dcfdde 100644 --- a/modules/discover/con-benefits-of-rhdh.adoc +++ b/modules/discover/con-benefits-of-rhdh.adoc @@ -1,18 +1,47 @@ :_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. +== 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, Continuous Integration/Continuous Delivery (CI/CD), Static Application Security Testing (SAST)/Dynamic Application Security Testing (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 is 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 time frame. -* 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. +Increased developer productivity:: +Eliminates 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 aspects such as: + +* Git +* Continuous Integration/Continuous Delivery (CI/CD) +* Static Application Security Testing (SAST)/Dynamic Application Security Testing (DAST) +* Supply Chain +* OpenShift/Kubernetes cluster +* JIRA +* Monitoring +* API +* Documentation + ++ +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 +* Establishing CI/CD pipelines for production deployment in Git + +Scalable technical documentation:: +Code and documentation is 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 time frame. + +Robust enterprise Role-Based Access Control (RBAC):: +Empowers administrators to: +* Create roles +* Assign users or groups to roles +* Implement robust security policies for enhanced access control -[role="_additional-resources"] .Additional resources -* For more information about the different 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[Overview of {product}]. \ No newline at end of file + * For more information about the different features of {product} and how to extend the upstream Backstage product, see link:https://developers.redhat.com/rhdh/overview[{product} overview]. From 74a7d72f4c316bc5f963fd3aa02ef29c89e3f029 Mon Sep 17 00:00:00 2001 From: jmagak Date: Wed, 6 Nov 2024 13:52:31 +0100 Subject: [PATCH 6/7] Updates Benefits of rhdh --- modules/discover/con-benefits-of-rhdh.adoc | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/modules/discover/con-benefits-of-rhdh.adoc b/modules/discover/con-benefits-of-rhdh.adoc index dc94dcfdde..381bc08f43 100644 --- a/modules/discover/con-benefits-of-rhdh.adoc +++ b/modules/discover/con-benefits-of-rhdh.adoc @@ -1,10 +1,7 @@ :_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}: += Benefits of {product} Increased developer productivity:: Eliminates common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications. @@ -44,4 +41,4 @@ Empowers administrators to: * Implement robust security policies for enhanced access control .Additional resources - * For more information about the different features of {product} and how to extend the upstream Backstage product, see link:https://developers.redhat.com/rhdh/overview[{product} overview]. + * For more information about the different features of {product} and how to extend it, see link:https://developers.redhat.com/rhdh/overview[{product} overview]. From d1e10653e0f8fcfb1e35f4de471649c9028b8fdc Mon Sep 17 00:00:00 2001 From: jmagak Date: Wed, 6 Nov 2024 15:23:04 +0100 Subject: [PATCH 7/7] Updates Benefits of rhdh --- modules/discover/con-benefits-of-rhdh.adoc | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/modules/discover/con-benefits-of-rhdh.adoc b/modules/discover/con-benefits-of-rhdh.adoc index 381bc08f43..a84367393a 100644 --- a/modules/discover/con-benefits-of-rhdh.adoc +++ b/modules/discover/con-benefits-of-rhdh.adoc @@ -7,7 +7,7 @@ Increased developer productivity:: Eliminates 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 aspects such as: +Provides development teams with a unified dashboard. Your platform engineering team can curate aspects such as: * Git * Continuous Integration/Continuous Delivery (CI/CD) @@ -19,9 +19,6 @@ Provides development teams with a unified dashboard covering aspects such as: * API * Documentation -+ -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