Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RHIDP 4569 Discover Chapter 1 Benefits of RHDH #647

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions assemblies/assembly_about-rhdh.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
:_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]






31 changes: 31 additions & 0 deletions modules/discover/con_benefits-of-rhdh.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
:_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.

{product} runs on {ocp-short} {ocp-version-min}-{ocp-version} on AMD64 and Intel 64 (`x86_64`) architectures. For more information about the different supported hosted environments, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_dev_spaces/3.12/html-single/release_notes_and_known_issues/index#supported-platforms[Supported platforms].


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.


[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?intcmp=7015Y000003swEuQAI&source=sso[{product}].
1 change: 1 addition & 0 deletions titles/discover/artifacts
1 change: 1 addition & 0 deletions titles/discover/assemblies
11 changes: 11 additions & 0 deletions titles/discover/docinfo.xml
Original file line number Diff line number Diff line change
@@ -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" />
1 change: 1 addition & 0 deletions titles/discover/images
14 changes: 14 additions & 0 deletions titles/discover/master.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
include::artifacts/attributes.adoc[]
:context: title-discover
:doctype: book
:imagesdir: images
:title: Discover
: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.

//[id="{context}"]
//= {title}

//{abstract}

include::assemblies/assembly_about-rhdh.adoc[]
1 change: 1 addition & 0 deletions titles/discover/modules