Clarify missingkey documentation #1898
Conversation
joebowbeer
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR clarifies the documentation for missingkey and reorganizes the descriptions of the include and required template functions to improve readability and reduce confusion.
- Simplified the explanation of Go's
missingkeybehavior by removing overly technical details abouttemplate.Options - Consolidated the
includeandrequiredfunction descriptions into subsections under the template functions introduction - Reorganized content to present both functions earlier in the document with more structured formatting
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| The above includes a template called `toYaml`, passes it `$value`, and then | ||
| passes the output of that template to the `indent` function. |
There was a problem hiding this comment.
In general I think folks prefer nindent over indent now, for readability reasons.
There was a problem hiding this comment.
But this can be updated in a follow-up PR. I realize you didn't really change this, just moved it higher up in the doc. In a follow-up PR, I would like to see us check all of the docs pages for indent examples and update them to nindent equivalents.
Signed-off-by: Joe Bowbeer <[email protected]>
scottrigby
left a comment
scottrigby
left a comment
There was a problem hiding this comment.
It's interesting that the missingkey docs previously mixed info on how to work with chart templating and also how to work with gotemplate using Go. The part you removed is about how to use this with Go, which I think you're right doesn't make sense here.
joejulian
left a comment
joejulian
left a comment
There was a problem hiding this comment.
This is much more readable, thanks!
4 participants
Fixes #1352
Changes:
includeandrequireddescriptions