Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.26 KB

documentation.md

File metadata and controls

28 lines (18 loc) · 1.26 KB

Documentation

Most README files are autogenerated. Use pre-commit or the tools in hack/ to regenerate them.

Chart Documentation

The helm-docs template used to render the charts READMEs is in hack/config/helm-docs/README.md.gotmpl.

Some of the named templates it defines are based on the upcoming 0.14 release of helm-docs and will be replaced once we update.

How to annotate values is described in the helm-docs README.

You can use hack/helm-docs.sh to update the chart READMEs.

root README and site index

The gomplate template used to render the root README page is in hack/config/update-readme/README.md.gotmpl.

It is used to render both the GitHub README as well as the GitHub Pages index. The differences between the two output are configured in some YAML files:

You can update the README page using hack/update-readme.md.