docs: add values.yaml conventions and section annotations#128
Draft
gavinelder wants to merge 1 commit intomasterfrom
Draft
docs: add values.yaml conventions and section annotations#128gavinelder wants to merge 1 commit intomasterfrom
gavinelder wants to merge 1 commit intomasterfrom
Conversation
Adds a conventions doc covering helm-docs comment style, sectioning rules, and inline-example patterns drawn from Bitnami and Grafana chart practices. Annotates every operator-facing value across the platform parent chart and all six subcharts with `# @section` markers, so the generated README tables group values by area instead of falling into a single flat list. Switches each chart's README.md.gotmpl from the default flat `chart.valuesSection` helper to a custom Markdown loop over `.Sections.Sections`. The loop renders one Markdown table per section, keeping diffs review-friendly (vs the HTML helper) and making sections visible in plain-text editors. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
gavinelder
force-pushed
the
values-conventions
branch
from
a0b7ce4 to
d5e2b88
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/conventions/values-yaml.md— a conventions guide for commenting and structuring chart values files, drawn from helm-docs idioms and patterns observed in Bitnami and Grafana charts.# @sectionmarkers (1,018 values across ~150 sections, named hierarchically withParent: Childfor sub-areas).README.md.gotmplflatchart.valuesSectionhelper with a custom Markdown loop over.Sections.Sections. The generated README values table is now grouped by section heading instead of one flat list.Notes for reviewers
Global: Azure Image Overrides(48 values) in the platform chart. May warrant splitting into per-cloud sub-sections later.# @sectionDescription. If a section needs prose orientation, hand-write that block in the gotmpl following the SurrealDB pattern ({{- range .Values }}{{- if hasPrefix "X" .Key }}).Test plan
charts/platform/charts/wave/README.md) and confirm sections render as expected# --description🤖 Generated with Claude Code