Skip to content

RHIDP-9554: helm chart values overview#1768

Open
deerskindoll wants to merge 35 commits intoredhat-developer:mainfrom
deerskindoll:RHIDP-9554
Open

RHIDP-9554: helm chart values overview#1768
deerskindoll wants to merge 35 commits intoredhat-developer:mainfrom
deerskindoll:RHIDP-9554

Conversation

@deerskindoll
Copy link
Copy Markdown
Member

@deerskindoll deerskindoll commented Feb 9, 2026 •
edited by jmagak
Loading

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

Version(s):

main, release-1.9
Issue:

https://issues.redhat.com/browse/RHIDP-9554
Preview:

helm-chart-config-reference

@deerskindoll deerskindoll changed the title RHIDP-9554: helm chart values overview DRAFT RHIDP-9554: helm chart values overview Feb 9, 2026
@deerskindoll deerskindoll added the Technical review needed 🔩 Test all the procedures label Feb 9, 2026
@deerskindoll deerskindoll changed the title DRAFT RHIDP-9554: helm chart values overview RHIDP-9554: helm chart values overview Feb 9, 2026
nickboldt
nickboldt reviewed Feb 10, 2026
View reviewed changes
Comment thread assemblies/assembly-overview-of-helm-chart-default-values.adoc Outdated
nickboldt
nickboldt reviewed Feb 10, 2026
View reviewed changes
Comment thread modules/helm-chart-config-reference/proc-display-a-list-of-helm-chart-values.adoc Outdated
@rm3l
Copy link
Copy Markdown
Member

rm3l commented Feb 10, 2026

/cc

@openshift-ci openshift-ci bot requested a review from rm3l February 10, 2026 20:25
@rm3l
Copy link
Copy Markdown
Member

rm3l commented Feb 12, 2026 •
edited
Loading

@deerskindoll would you mind sharing a link to the preview? Looks like the workflow has failed: https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/actions/runs/21883008119/job/63171471408?pr=1768
Thanks.

rm3l
rm3l reviewed Feb 12, 2026
View reviewed changes
Comment thread modules/helm-chart-config-reference/proc-display-a-list-of-helm-chart-values.adoc Outdated
@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Feb 16, 2026 •
edited
Loading

❌ Build failed

34/34 titles built successfully | 0 failed | 121s

CQA (Content Quality Assessment)

19 checks: 13 pass, 6 fail

CQA checklist

CQA Report

  • CQA-00a: Orphaned modules (1 issues)
    • [AUTOFIX] assemblies/assembly-enabling-service-to-service-authentication.adoc: Orphaned .adoc file (not included anywhere)
  • CQA-00b: Directory structure (1 issues)
    • [MANUAL] titles/helm-chart-config-reference/master.adoc: Missing :_mod-docs-category: attribute
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure (9 issues)
    • [AUTOFIX] titles/helm-chart-config-reference/master.adoc: Line 1: Content type ASSEMBLY not on first line
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: Missing :context: attribute
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: Line 2: Missing context save on line 2
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: Missing context restore (second-to-last line)
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: Missing context restore (last line)
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: Missing :context: attribute
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: Line 2: Missing context save on line 2
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: Missing context restore (second-to-last line)
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: Missing context restore (last line)
  • CQA-03: Verify content type metadata (1 issues)
    • [AUTOFIX] titles/helm-chart-config-reference/master.adoc: Line 1: Missing :_mod-docs-content-type: -- add ASSEMBLY
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements (7 issues)
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 32: Non-standard block title: .Values.upstream.postgresql.image.registry }}/{{
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 33: Non-standard block title: .Values.upstream.postgresql.image.repository }}:{{
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 34: Non-standard block title: .Values.upstream.postgresql.image.tag }}"
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 82: Non-standard block title: .Values.upstream.postgresql.image.registry }}/{{
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 83: Non-standard block title: .Values.upstream.postgresql.image.repository }}:{{
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 84: Non-standard block title: .Values.upstream.postgresql.image.tag }}"
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-route-namespace-values.adoc: Line 17: Non-standard block title: .Values.global.host
  • 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 (22 issues)
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: ID: overview-of-helm-chart-default-values -> helm-chart-configuration-reference
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: File: assembly-overview-of-helm-chart-default-values.adoc -> assembly-helm-chart-configuration-reference.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/proc-display-a-list-of-helm-chart-values.adoc: File: proc-display-a-list-of-helm-chart-values.adoc -> proc-display-a-complete-list-of-helm-chart-values-with-helm-cli.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-root-namespace-value.adoc: ID: helm-chart-root-namespace-value -> root-namespace-value
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-root-namespace-value.adoc: File: ref-helm-chart-root-namespace-value.adoc -> ref-root-namespace-value.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-global-namespace-values.adoc: File: ref-helm-chart-global-namespace-values.adoc -> ref-global-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: ID: helm-chart-orchestrator-namespace-values -> orchestrator-namespace-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: File: ref-helm-chart-orchestrator-namespace-values.adoc -> ref-orchestrator-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-route-namespace-values.adoc: ID: helm-chart-route-namespace-values -> route-namespace-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-route-namespace-values.adoc: File: ref-helm-chart-route-namespace-values.adoc -> ref-route-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-test-namespace-values.adoc: ID: helm-chart-test-namespace-values -> test-namespace-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-test-namespace-values.adoc: File: ref-helm-chart-test-namespace-values.adoc -> ref-test-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-upstream-namespace-values.adoc: ID: helm-chart-upstream-namespace-values -> upstream-namespace-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-upstream-namespace-values.adoc: File: ref-helm-chart-upstream-namespace-values.adoc -> ref-upstream-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-additional-upstream-namespace-values.adoc: ID: helm-chart-additional-upstream-namespace-values -> additional-upstream-backstage-chart-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-additional-upstream-namespace-values.adoc: File: ref-helm-chart-additional-upstream-namespace-values.adoc -> ref-additional-upstream-backstage-chart-values.adoc
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: ID: helm -> helm-chart-orchestrator-infrastructure-reference
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: File: assembly-overview-of-helm-chart-orchestrator-infra.adoc -> assembly-helm-chart-orchestrator-infrastructure-reference.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/proc-display-a-list-of-orchestrator-infra-values.adoc: ID: display-a-complete-list-of-orchestrator-infra-values-with-helm-cli -> display-a-complete-list-of-orchestrator-infrastructure-values-with-helm-cli
    • [AUTOFIX] modules/helm-chart-config-reference/proc-display-a-list-of-orchestrator-infra-values.adoc: File: proc-display-a-list-of-orchestrator-infra-values.adoc -> proc-display-a-complete-list-of-orchestrator-infrastructure-values-with-helm-cli.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-infra.adoc: ID: helm-chart-orchestrator-infra -> orchestrator-infrastructure-helm-chart-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-infra.adoc: File: ref-helm-chart-orchestrator-infra.adoc -> ref-orchestrator-infrastructure-helm-chart-values.adoc
  • 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-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 13 pass, 6 fail
Issues: 41 total (33 autofixable, 8 manual, 3 delegated)
Run node build/scripts/cqa/index.js --fix --all to auto-resolve 33 issues.

Run node build/scripts/cqa/index.js --all locally for details.

View full logs | 4/18/2026, 4:03:26 AM

@deerskindoll
Copy link
Copy Markdown
Member Author

deerskindoll commented Feb 16, 2026

@deerskindoll would you mind sharing a link to the preview? Looks like the workflow has failed: https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/actions/runs/21883008119/job/63171471408?pr=1768 Thanks.

done

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Apr 15, 2026 •
edited
Loading

Content Quality Assessment Results

CQA Report

  • CQA-00a: Orphaned modules (1 issues)
    • [AUTOFIX] assemblies/assembly-enabling-service-to-service-authentication.adoc: Orphaned .adoc file (not included anywhere)
  • CQA-00b: Directory structure (1 issues)
    • [MANUAL] titles/helm-chart-config-reference/master.adoc: Missing :_mod-docs-category: attribute
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure (9 issues)
    • [AUTOFIX] titles/helm-chart-config-reference/master.adoc: Line 1: Content type ASSEMBLY not on first line
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: Missing :context: attribute
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: Line 2: Missing context save on line 2
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: Missing context restore (second-to-last line)
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: Missing context restore (last line)
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: Missing :context: attribute
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: Line 2: Missing context save on line 2
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: Missing context restore (second-to-last line)
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: Missing context restore (last line)
  • CQA-03: Verify content type metadata (1 issues)
    • [AUTOFIX] titles/helm-chart-config-reference/master.adoc: Line 1: Missing :_mod-docs-content-type: -- add ASSEMBLY
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements (7 issues)
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 32: Non-standard block title: .Values.upstream.postgresql.image.registry }}/{{
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 33: Non-standard block title: .Values.upstream.postgresql.image.repository }}:{{
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 34: Non-standard block title: .Values.upstream.postgresql.image.tag }}"
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 82: Non-standard block title: .Values.upstream.postgresql.image.registry }}/{{
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 83: Non-standard block title: .Values.upstream.postgresql.image.repository }}:{{
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: Line 84: Non-standard block title: .Values.upstream.postgresql.image.tag }}"
    • [MANUAL] modules/helm-chart-config-reference/ref-helm-chart-route-namespace-values.adoc: Line 17: Non-standard block title: .Values.global.host
  • 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 (22 issues)
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: ID: overview-of-helm-chart-default-values -> helm-chart-configuration-reference
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-default-values.adoc: File: assembly-overview-of-helm-chart-default-values.adoc -> assembly-helm-chart-configuration-reference.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/proc-display-a-list-of-helm-chart-values.adoc: File: proc-display-a-list-of-helm-chart-values.adoc -> proc-display-a-complete-list-of-helm-chart-values-with-helm-cli.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-root-namespace-value.adoc: ID: helm-chart-root-namespace-value -> root-namespace-value
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-root-namespace-value.adoc: File: ref-helm-chart-root-namespace-value.adoc -> ref-root-namespace-value.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-global-namespace-values.adoc: File: ref-helm-chart-global-namespace-values.adoc -> ref-global-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: ID: helm-chart-orchestrator-namespace-values -> orchestrator-namespace-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-namespace-values.adoc: File: ref-helm-chart-orchestrator-namespace-values.adoc -> ref-orchestrator-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-route-namespace-values.adoc: ID: helm-chart-route-namespace-values -> route-namespace-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-route-namespace-values.adoc: File: ref-helm-chart-route-namespace-values.adoc -> ref-route-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-test-namespace-values.adoc: ID: helm-chart-test-namespace-values -> test-namespace-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-test-namespace-values.adoc: File: ref-helm-chart-test-namespace-values.adoc -> ref-test-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-upstream-namespace-values.adoc: ID: helm-chart-upstream-namespace-values -> upstream-namespace-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-upstream-namespace-values.adoc: File: ref-helm-chart-upstream-namespace-values.adoc -> ref-upstream-namespace-values.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-additional-upstream-namespace-values.adoc: ID: helm-chart-additional-upstream-namespace-values -> additional-upstream-backstage-chart-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-additional-upstream-namespace-values.adoc: File: ref-helm-chart-additional-upstream-namespace-values.adoc -> ref-additional-upstream-backstage-chart-values.adoc
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: ID: helm -> helm-chart-orchestrator-infrastructure-reference
    • [AUTOFIX] assemblies/assembly-overview-of-helm-chart-orchestrator-infra.adoc: File: assembly-overview-of-helm-chart-orchestrator-infra.adoc -> assembly-helm-chart-orchestrator-infrastructure-reference.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/proc-display-a-list-of-orchestrator-infra-values.adoc: ID: display-a-complete-list-of-orchestrator-infra-values-with-helm-cli -> display-a-complete-list-of-orchestrator-infrastructure-values-with-helm-cli
    • [AUTOFIX] modules/helm-chart-config-reference/proc-display-a-list-of-orchestrator-infra-values.adoc: File: proc-display-a-list-of-orchestrator-infra-values.adoc -> proc-display-a-complete-list-of-orchestrator-infrastructure-values-with-helm-cli.adoc
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-infra.adoc: ID: helm-chart-orchestrator-infra -> orchestrator-infrastructure-helm-chart-values
    • [AUTOFIX] modules/helm-chart-config-reference/ref-helm-chart-orchestrator-infra.adoc: File: ref-helm-chart-orchestrator-infra.adoc -> ref-orchestrator-infrastructure-helm-chart-values.adoc
  • 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-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 13 pass, 6 fail
Issues: 41 total (33 autofixable, 8 manual, 3 delegated)
Run node build/scripts/cqa/index.js --fix --all to auto-resolve 33 issues.

Automated CQA check run on the entire repository — 2026-04-18 04:02:36 UTC

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 18, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

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

Reviewers

@nickboldt nickboldt nickboldt left review comments

@themr0c themr0c Awaiting requested review from themr0c

+2 more reviewers

@OpinionatedHeron OpinionatedHeron OpinionatedHeron left review comments

@rm3l rm3l rm3l approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

@rm3l rm3l

@OpinionatedHeron OpinionatedHeron

Labels

do-no-merge/review-in-progress 👀 Peer review needed 📖

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@deerskindoll @rm3l @rhdh-bot @openshift-cherrypick-robot @nickboldt @themr0c @OpinionatedHeron @jmagak
⚡