docs(chart_template_guide): point YAML Anchors at library charts#2117
Open
edu-diaz wants to merge 5 commits into
Open
docs(chart_template_guide): point YAML Anchors at library charts#2117edu-diaz wants to merge 5 commits into
edu-diaz wants to merge 5 commits into
Conversation
When readers reach the YAML Anchors appendix, a common motivation is DRY-ing up shared snippets across charts. Library charts are the Helm-native way to do that and aren't affected by the round-trip pitfall the section already describes. Add a short info admonition at the end of the section linking to /topics/library_charts. Mirrored in both versioned_docs/version-3 and docs (next). Signed-off-by: Eduardo Diaz <edudiazasencio@gmail.com>
Contributor
paigecalvert
left a comment
paigecalvert
left a comment
There was a problem hiding this comment.
Thanks @edu-diaz . I added some copy edits for style/clarity; otherwise this lgtm!
… admonition
Tighten the wording in the new YAML Anchors → library charts admonition
per review feedback: lead with the recommendation ("use library charts
instead of YAML anchors") and split the rationale into a second sentence.
Same change mirrored in docs/ (next) and versioned_docs/version-3 (GA).
Signed-off-by: Eduardo Diaz <edudiazasencio@gmail.com>
Author
|
@paigecalvert hey thanks I applied your suggested changes |
paigecalvert
approved these changes
Jun 2, 2026
Contributor
paigecalvert
left a comment
paigecalvert
left a comment
There was a problem hiding this comment.
@TerryHowe this lgtm from a docs perspective. Could use your 👍 before merging to make sure you agree with the library charts recommendation.
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
2 participants
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.
What
Adds a short info admonition at the end of the YAML Anchors appendix in the Chart Template Guide, linking to Library Charts.
Applied to both
versioned_docs/version-3/chart_template_guide/yaml_techniques.md(current GA) anddocs/chart_template_guide/yaml_techniques.md(next).Why
The YAML Anchors section already warns that anchors are lost on the round-trip through Helm/Kubernetes, but it doesn't tell readers what to reach for instead. A common motivation for using anchors in chart templates is DRY — sharing snippets across charts. Library charts are exactly the Helm-native mechanism for that case, and they don't suffer from the round-trip pitfall the existing section describes.
A small cross-reference at the end of the section nudges readers toward the right tool when DRY is the goal, without disrupting the rest of the appendix.
Preview
Checklist
:::infoadmonition convention already used elsewhere in the v4 docs (e.g.docs/overview.md,docs/plugins/developer/index.mdx)[text](/topics/library_charts.md)convention (matching e.g.chart_template_guide/subcharts_and_globals.md)