Skip to content

[RHIDP#14276]: Document new standalone Helm chart values reference - #2500

Open
rh-tokeefe wants to merge 5 commits into
redhat-developer:release-2.1from
rh-tokeefe:RHIDP-14276
Open

[RHIDP#14276]: Document new standalone Helm chart values reference#2500
rh-tokeefe wants to merge 5 commits into
redhat-developer:release-2.1from
rh-tokeefe:RHIDP-14276

Conversation

@rh-tokeefe

Copy link
Copy Markdown
Member

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

Version(s): 2.1

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

Preview: N/A (draft — pending chart PR merge)

Summary

  • Add 13 new reference modules documenting the standalone RHDH Helm chart values (replaces the old upstream Backstage subchart-based reference)
  • Update assembly to include new modules and remove old upstream namespace references
  • Update helm show values procedure for new chart name (rhdh)
  • Update {default-helm-chart-values-link} attribute to point to charts/rhdh/values.yaml

Notes

This is a draft based on the current state of the developer's branch (rhdh-chart PR 438). The values schema may change after the developer returns from PTO. The old reference modules (upstream namespace, additional upstream values) are left on disk for release-1.x branches but removed from the assembly includes.

Related dev feature: RHDHPLAN-1058

Test plan

  • Verify all 13 new reference modules render correctly in HTML preview
  • Cross-check values against final charts/rhdh/values.yaml when chart PR merges
  • Confirm no broken cross-references in the Helm chart config reference title
  • Run CQA checks

🤖 Generated with Claude Code

rh-tokeefe and others added 4 commits July 24, 2026 12:33
…chart

Replace the old upstream Backstage subchart-based reference modules with
13 focused reference modules covering the new standalone chart's flat
values structure. Update assembly includes, helm CLI procedure, and
chart attributes to match.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@rhdh-bot

rhdh-bot commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

PR Build Results

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


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
  • CQA-jtbd-02: Modules not yet in product_product (informational)

Summary

Checks: 22 total, 22 pass, 0 fail

Modules not yet in product_product

13 modules (proc, con, ref) are not yet included in the product_product title.

modules/configure_helm-chart-config-reference/ (13)
  • modules/configure_helm-chart-config-reference/ref-application-config-values.adoc
  • modules/configure_helm-chart-config-reference/ref-database-values.adoc
  • modules/configure_helm-chart-config-reference/ref-deployment-and-pod-values.adoc
  • modules/configure_helm-chart-config-reference/ref-dynamic-plugins-values.adoc
  • modules/configure_helm-chart-config-reference/ref-environment-and-command-override-values.adoc
  • modules/configure_helm-chart-config-reference/ref-global-and-chart-values.adoc
  • modules/configure_helm-chart-config-reference/ref-image-values.adoc
  • modules/configure_helm-chart-config-reference/ref-lightspeed-values.adoc
  • modules/configure_helm-chart-config-reference/ref-metrics-values.adoc
  • modules/configure_helm-chart-config-reference/ref-networking-values.adoc
  • modules/configure_helm-chart-config-reference/ref-openshift-values.adoc
  • modules/configure_helm-chart-config-reference/ref-orchestrator-values.adoc
  • modules/configure_helm-chart-config-reference/ref-test-values.adoc

22 checks: 22 pass, 0 fail

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


Updated 2026-07-24 17:19:43 UTC

The asterisks in `*Override` and `extra*` inside backticks caused
mismatched emphasis/literal tags in DocBook XML. Reworded to use
explicit key names instead.

Reverted the helm chart values link back to charts/backstage/values.yaml
since charts/rhdh/values.yaml does not exist on release-1.10 yet.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@sonarqubecloud

Copy link
Copy Markdown

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants