Skip to content

RHIDP-14692: JTBD Optimize - Scale system performance for growing traffic#2391

Closed
rh-tokeefe wants to merge 11 commits into
redhat-developer:mainfrom
rh-tokeefe:RHIDP-14692
Closed

RHIDP-14692: JTBD Optimize - Scale system performance for growing traffic#2391
rh-tokeefe wants to merge 11 commits into
redhat-developer:mainfrom
rh-tokeefe:RHIDP-14692

Conversation

@rh-tokeefe

Copy link
Copy Markdown
Member

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s):
2.1.0

Issue:
https://redhat.atlassian.net/browse/RHIDP-14692

Summary:
Implements the JTBD Level 2 job "Scale system performance for growing traffic" under the Optimize category. Creates parent topic with job statement and all 4 Level 3 topics with JTBD-focused content.

Changes:

  • Created parent topic overview with job statement, user goals, and RHDH solution
  • Filled in 4 Level 3 concept topics:
    • Plan production scaling using high availability architecture
    • Configure high availability to maintain performance
    • Configure the dynamic plugins cache
    • Enable the plugin assets cache
  • Updated navigation map to include all Level 3 topics
  • Added xref links to existing procedures in Configure book
  • Created new concept and nav files for plugin assets cache

JIRA Acceptance Criteria Met:

  • ✅ Parent topic created with natural language title
  • ✅ Job statement documented
  • ✅ User's goal described (what and why)
  • ✅ Overview of how RHDH solves the problem
  • ✅ High-level steps with links to related content
  • ✅ All Level 3 topics nested correctly
  • ✅ TOC nesting does not exceed three levels
  • ✅ Action-oriented, JTBD-style phrasing
  • ✅ No existing file IDs or names modified

Preview:
Will be available after build completes

…ffic"

Created parent topic and all Level 3 topics for the "Scale system
performance for growing traffic" job under the Optimize category.

Changes:
- Added job statement and overview to parent concept
- Filled in all 4 Level 3 concept topics with JTBD-focused content
- Updated navigation map to include all Level 3 topics
- Added xref links to existing procedures in Configure book
- Created new concept and nav files for plugin assets cache

All topics use action-oriented, outcome-focused titles following
JTBD principles. No existing file IDs or names were modified.

Level 3 topics completed:
1. Plan production scaling using high availability architecture
2. Configure high availability to maintain performance
3. Configure the dynamic plugins cache
4. Enable the plugin assets cache

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@rhdh-bot

rhdh-bot commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 36/36 titles | 82s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2391/


Content Quality Assessment

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-14b: Inbound link stability (no ID changes for existing files)
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features
  • CQA-jtbd-01: Verify navigation file structure

Summary

Checks: 21 total, 21 pass, 0 fail

21 checks: 21 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.


Updated 2026-06-17 20:06:56 UTC

Added [id] attributes to all concept files to resolve document
structure validation errors. IDs follow pattern: <topic>-overview_{context}

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Remove .Related procedures sections from nav files (CQA-jtbd-01)
- Shorten abstracts to under 300 chars (CQA-09)
- Add why optimize section explaining user pain points
- Add what you can optimize section covering key areas
- Add how to approach optimization workflow
- Follow JTBD user-centric pattern from Level 2 Job concepts
- Add [role="_abstract"] to all 5 nav files (CQA-09 requirement)
- Fix 24/7 -> 24x7 (RedHat.TermsErrors)
- Fix spend -> expend (RedHat.TermsErrors)
- Update proc-configure-high-availability-in-a-rhdh-operator-deployment.adoc title
- Update proc-configure-high-availability-in-a-rhdh-helm-chart-deployment.adoc title
- Add both procedures to nav-configure-high-availability-to-maintain-performance.adoc
- File names and IDs remain unchanged to preserve links
- Change 'Configure high availability using the Operator' to 'Configure with the Operator'
- Change 'Configure high availability using the Helm chart' to 'Configure with the Helm chart'
- Fix include paths: ../../modules -> ../../../../modules (correct relative path)
- Remove [role="_abstract"] from all 5 nav files (CQA-jtbd-01: navigation files must contain only title and includes)
- Rename PVC procedure titles to "Create PVC with Operator" and
  "Create PVC with Helm Chart"
- Fill in "Create a persistent volume claim" concept with PVC
  requirements, deployment methods, and access mode guidance
- Create "Resolve plugin configuration errors" concept covering
  pod startup failures, 404 cache errors, and schema validation
- Wire all topics into the dynamic plugins cache nav

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The CI build jail prevents ../../../../ ancestor path references.
Use the modules/ directory available under the optimize category.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@rh-tokeefe

Copy link
Copy Markdown
Member Author

closing this part. it was my first attempt using the claude skill and some things were not done correctly. the newly created PR is here: #2393

@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants