helm-www icon indicating copy to clipboard operation
helm-www copied to clipboard

Document TOML, YAML and JSON functions

Open sheisnicola opened this issue 3 years ago • 3 comments

Please see:

  • https://github.com/helm/helm/issues/7888 (incorrectly closed as a duplicate)
  • https://github.com/helm/helm-www/issues/489#issuecomment-729863024

Helm defines a few functions of its own in pkg/engine/func.go for serializing and deserializing data

https://github.com/helm/helm/blob/b735abe8371359fcf0b37de8014bfafcceb1bcf8/pkg/engine/funcs.go#L50-L57

I suggest we add documentation about these functions along with the documentation for the include, required and template functions as well as in the chart template guide section about template functions.

I suggest that the following links also be referenced in the documentation, or the omissions from the Helm documentation be fixed. The text/template documentation is especially useful as it describes some aspects of value assignment and syntax that are completely absent in the Helm docs:

  • https://masterminds.github.io/sprig/
  • https://godoc.org/text/template

sheisnicola avatar Sep 20 '21 14:09 sheisnicola

Hi @sheisnicola. I agree that documentation surrounding these functions built into Helm's template engine would be useful. Please feel free to provide a PR to document their behavior.

If I understand correctly, https://pkg.go.dev/text/template is the new canonical location for any standard library docs (godoc.org now redirects to that location), so I would suggest we point users there instead of godoc.org.

bacongobbler avatar Sep 20 '21 14:09 bacongobbler

@sheisnicola Can you create a PR for this. Thanks very much.

yxxhero avatar Apr 01 '22 00:04 yxxhero

@yxxhero #1309

nofearOnline avatar Sep 07 '22 04:09 nofearOnline