-
Notifications
You must be signed in to change notification settings - Fork 61
RHIDP-12203: CQA 2.1 compliance for About Red Hat Developer Hub title #1872
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,8 @@ | |
| [id="understanding-internal-developer-platforms_{context}"] | ||
| = Understanding internal developer platforms | ||
|
|
||
| An internal developer platform (IDP) is a curated set of tools and services that supports developer self-service. Instead of navigating multiple systems, developers use a unified interface to provision environments, deploy code, and access APIs. | ||
| [role="_abstract"] | ||
| Internal developer platforms enable developer self-service through a unified interface for provisioning environments, deploying code, and accessing APIs, reducing complexity across development workflows. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To improve readability, I'd split this into two sentences: Internal developer platforms (IDPs) provide a unified interface that enables developer self-service for provisioning environments, deploying code, and accessing APIs. By centralizing these tools, IDPs reduce complexity across development workflows. |
||
|
|
||
| Why IDPs matter:: | ||
|
|
||
|
|
@@ -30,7 +31,7 @@ For developers:: | |
| * *Cross-team visibility:* Developers can discover shared service catalogs and documentation to improve reuse and reduce duplication. | ||
| * *Higher productivity:* Developers can spend more time building features and less time configuring infrastructure or resolving toolchain inconsistencies. | ||
|
|
||
| .Key features | ||
| == Key features | ||
|
|
||
| Centralized dashboard:: | ||
| Access development tools, CI/CD pipelines, APIs, monitoring tools, and documentation from a single interface. Integrate with systems like Git, {ocp-brand-name}, Kubernetes, and JIRA. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,9 @@ | |
| [id="ref-customer-support-info_{context}"] | ||
| = {product} support | ||
|
|
||
| [role="_abstract"] | ||
| {company-name} provides support resources through the Customer Portal, including technical support articles and the ability to create support cases for Global Support Services. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The short description repeats what is already in the module body. I think you can just separate the first sentence from the body and make it the short des: "If you experience difficulty with a procedure described in this documentation, visit the {company-name} Customer Portal for more resources." |
||
|
|
||
| If you experience difficulty with a procedure described in this documentation, visit the {company-name} Customer Portal. | ||
| You can use the {company-name} Customer Portal for the following purposes: | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,9 @@ | |
| [id="rhdh-sizing_{context}"] | ||
| = Sizing requirements for {product} | ||
|
|
||
| Learn about sizing requirements for {product}. | ||
| [role="_abstract"] | ||
| Plan infrastructure resources for {product} deployments using sizing requirements for the application, database, and Operator based on deployment scale. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The last four words of the sentence are redundant, so I'd delete them. |
||
|
|
||
| Table 1 lists the sizing requirements for installing and running {product}, including {product-short} application, database components, and Operator. | ||
| Table 2 lists recommended sizing requirements for {product-docs-link}/html-single/configuring_red_hat_developer_hub/index#configuring-external-postgresql-databases[external PostgreSQL deployment] based on the deployment scale. | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To improve readability, split into two sentences:
Achieving high availability in {product} requires implementing redundancy and failover for both the backend service and its data dependencies. This is accomplished through horizontal scaling, database replication, and shared caching to ensure continuous operation during component failures.