Skip to content

Commit b8d6973

Browse files
gtrivedi88themr0c
andauthored
chore: ccutil to use the article doctype (redhat-developer#763) (redhat-developer#724)
Signed-off-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]>
1 parent 6a8c463 commit b8d6973

File tree

4 files changed

+96
-38
lines changed

4 files changed

+96
-38
lines changed

artifacts/attributes.adoc

+20
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,26 @@
4848
:rhbk: RHBK
4949
:keycloak-version: 24.0
5050

51+
// RHTAP information
52+
:rhtap-version: 1.3
53+
:rhtap-brand-name: Red Hat Trusted Application Pipeline
54+
:rhtap-very-short: RHTAP
55+
56+
// TAS information
57+
:rhtas-brand-name: Red Hat Trusted Artifact Signer
58+
:rhtas-short: Trusted Artifact Signer
59+
:rhtas-very-short: TAS
60+
61+
// TPA information
62+
:rhtpa-brand-name: Red Hat Trusted Profile Analyzer
63+
:rhtpa-short: Trusted Profile Analyzer
64+
:rhtpa-very-short: TPA
65+
66+
// ACS information
67+
:rhacs-brand-name: Red Hat Advanced Cluster Security
68+
:rhacs-short: Advanced Cluster Security
69+
:rhacs-very-short: ACS
70+
5171
// Partner Platforms
5272
:aws-brand-name: Amazon Web Services
5373
:aws-short: AWS

assemblies/assembly-about-rhdh.adoc

+3-5
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,12 @@ endif::[]
1212

1313
:context: about-rhdh
1414

15-
{product} is a fully supported, open developer platform that reduces friction and frustration of developers while boosting productivity.
16-
17-
This platform is driven by a centralized software catalog, providing efficiency to your microservices and infrastructure.
18-
19-
Use {product} to simplify decision-making through a selection of internally approved tools, programming languages, and developer resources within a self-managed portal.
15+
{product} ({product-very-short}) is an enterprise-grade internal developer portal designed to simplify and streamline software development processes. Combined with {ocp-brand-name}, {product-very-short} empowers platform engineering teams to create customized portals that improve developer productivity, accelerate onboarding, and enable faster application delivery. By reducing friction and complexity, {product-very-short} allows developers to focus on writing high-quality code while adhering to enterprise-class best practices.
2016

17+
{product-very-short} integrates software templates, pre-designed solutions, and dynamic plugins into a centralized platform, providing tailored solutions for operations and development teams in a unified environment.
2118

2219
include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]
20+
include::modules/about/con_integrations-in-rhdh.adoc[leveloffset=+1]
2321
include::modules/about/ref-supported-platforms.adoc[leveloffset=+1]
2422
include::modules/about/ref-rhdh-sizing.adoc[leveloffset=+1]
2523
include::modules/about/ref-customer-support-info.adoc[leveloffset=+1]

modules/about/con-benefits-of-rhdh.adoc

+40-33
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,46 @@
33
[id="benefits-of-rhdh_{context}"]
44
= Benefits of {product}
55

6-
Increased developer productivity::
7-
Eliminates common organizational challenges, enabling seamless collaboration, and providing clear guidelines for creating, developing, and deploying applications.
8-
9-
Unified Self-Service Dashboard::
10-
Provides development teams with a unified dashboard. Your platform engineering team can curate aspects such as:
11-
12-
* Git
13-
* Continuous Integration/Continuous Delivery (CI/CD)
14-
* Static Application Security Testing (SAST)/Dynamic Application Security Testing (DAST)
15-
* Supply Chain
16-
* OpenShift/Kubernetes cluster
17-
* JIRA
18-
* Monitoring
19-
* API
20-
* Documentation
21-
22-
Best practices through software templates::
23-
Automates organizational best practices by encoding common tasks such as:
24-
* Creating new applications
25-
* Running Ansible jobs
26-
* Establishing CI/CD pipelines for production deployment in Git
27-
28-
Scalable technical documentation::
29-
Code and documentation is in the same repository, eliminating dependencies on proprietary document systems.
30-
31-
Efficient onboarding for new developers::
32-
New developers can adapt quickly and become productive within a short time frame.
33-
34-
Robust enterprise Role-Based Access Control (RBAC)::
35-
Empowers administrators to:
36-
* Create roles
37-
* Assign users or groups to roles
38-
* Implement robust security policies for enhanced access control
6+
{product} offers targeted benefits for developers, platform engineers, and organizations by simplifying workflows, improving productivity, and enabling efficient governance.
397

8+
For developers::
9+
10+
* Simplified access to tools, resources, and workflows through a centralized dashboard.
11+
* Self-service capabilities with guardrails for cloud-native development.
12+
* Streamlined software and service creation using pre-configured templates.
13+
14+
For Platform engineers::
15+
16+
* Tailored platforms with curated tools to support developers efficiently.
17+
* Centralized repositories for consistent configuration management.
18+
* Simplified governance of technology choices and operational processes.
19+
20+
For organizations::
21+
22+
* Scalability to onboard new teams quickly while maintaining consistency.
23+
* Enhanced security with enterprise-grade Role-Based Access Control (RBAC).
24+
* Cost and time efficiency by mitigating cognitive load and eliminating workflow bottlenecks.
25+
26+
== Key features
27+
28+
Centralized Dashboard::
29+
Provides a single interface for accessing developer tools, CI/CD pipelines, APIs, monitoring tools, and documentation. Integrated with systems like Git, OpenShift, Kubernetes, and JIRA.
30+
31+
Dynamic Plugins::
32+
Add, update, or remove plugins dynamically without downtime. Popular plugins like Tekton, GitOps, Nexus Repository, and JFrog Artifactory are supported and verified by Red Hat.
33+
34+
Software Templates::
35+
Simplify development processes by automating tasks such as repository setup, variable insertion, and production pipeline creation.
36+
37+
Role-Based Access Control (RBAC)::
38+
Manage user access with robust security permissions tailored to organizational needs.
39+
40+
Scalability::
41+
Support growing teams and applications while maintaining access to the same tools and services.
42+
43+
Configuration Management::
44+
Centralized repositories ensure synchronized updates, improving version control and environment configuration.
45+
46+
[role="_additional-resources"]
4047
.Additional resources
4148
* For more information about the different features of {product} and how to extend it, see link:https://developers.redhat.com/rhdh/overview[{product} overview].
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="integrations-in-rhdh_{context}"]
4+
= Integrations in {product}
5+
6+
{product} integrates seamlessly with {ocp-brand-name} and other tools, enabling comprehensive development and deployment workflows across enterprise.
7+
8+
== Integration with {ocp-brand-name}
9+
{product} is fully integrated with {ocp-brand-name}, offering:
10+
11+
* Operators to manage application lifecycle.
12+
* Access to advanced OpenShift capabilities such as service mesh, serverless functions, GitOps, and distributed tracing.
13+
* Pipelines and GitOps plugins for streamlined cloud-native workflows.
14+
15+
== Integration with {rhtap-brand-name}
16+
{rhtap-brand-name} ({rhtap-very-short}) enhances {product} by providing secure CI/CD capabilities that integrate security measures into every stage of the development process.
17+
18+
While {product} focuses on the inner loop (code, build, and test), {rhtap-very-short} manages the outer loop, automating:
19+
20+
* Code scanning
21+
* Image building
22+
* Vulnerability detection
23+
* Deployment
24+
25+
{rhtap-very-short} includes tools like {rhtas-brand-name} ({rhtas-very-short}) for code integrity, {rhtpa-brand-name} ({rhtpa-very-short}) for automated Software build of Materials (SBOM) creation, and {rhacs-brand-name} ({rhacs-very-short}) for vulnerability scanning.
26+
27+
== Extending Backstage with {product}
28+
{product} which is a fully supported, enterprise-grade productized version of upstream Backstage extends the upstream project by adding:
29+
30+
* Enhanced search capabilities that aggregate data from CI/CD pipelines, cloud providers, source control, and more.
31+
* A centralized software catalog for locating applications, APIs, and resources.
32+
* Automation through open-source plugins that expand Backstage’s core functionality.
33+
* Simplified technical documentation using Markdown and GitHub, with integrated search for easy navigation.

0 commit comments

Comments
 (0)