RHIDP-12203: CQA 2.1 compliance for About Red Hat Developer Hub title#1872
RHIDP-12203: CQA 2.1 compliance for About Red Hat Developer Hub title#1872themr0c wants to merge 1 commit intoredhat-developer:mainfrom
Conversation
Enhance About title for Adobe Experience Manager migration compliance: - Add short descriptions with [role="_abstract"] to all modules - Convert DITA-incompatible block titles to section headings - Fix grammar and parallel structure issues - Improve concept module title from imperative to noun phrase - Add context restoration to assembly file - Remove commented-out content All changes pass Vale DITA validation with 0 errors, 0 warnings. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
|
|
||
| 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. |
There was a problem hiding this comment.
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.
|
|
||
| To achieve high availability (HA) in {product}, you must implement redundancy and failover for the backend service and its external data dependencies. This configuration uses horizontal scaling, database replication, and a shared logical cache to make sure {product-very-short} remains operational during component failures. | ||
| [role="_abstract"] | ||
| High availability in {product} requires redundancy and failover for the backend service and data dependencies by using horizontal scaling, database replication, and shared caching to ensure continuous operation during failures. |
There was a problem hiding this comment.
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.
| = {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. |
There was a problem hiding this comment.
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."
|
|
||
| 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. |
There was a problem hiding this comment.
The last four words of the sentence are redundant, so I'd delete them.
3 participants
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s): main
Issue: https://issues.redhat.com/browse/RHIDP-12203
Preview: To be added
Summary
This PR enhances the "About Red Hat Developer Hub" title for CQA 2.1 compliance and Adobe Experience Manager (AEM) migration readiness:
[role="_abstract"]with 50-300 character descriptions.Titleformat) to section headings (== Titleformat)Files Changed
All CQA 2.1 acceptance criteria are met, making this content ready for AEM migration.