Use helm-doc to create helm chart README

[delhage]

By annotating the values.yaml file properly, helm-doc can automatically render a table of configuration parameters, with description and default values.

See: https://github.com/norwoodj/helm-docs

Helm-docs could run via github actions on e.g. PR events.

[juriroemer]

I like the idea, but am not a big fan of either having to run this locally in a commit hook (that just screams for trouble with all kinds of people working on the project) or having bot commits through gh actions.

I think writing a little script that updates helm-docs and also adds a note to the Changelog.md that the values have changed is a possibility. Even if that would need to be run locally and manually: It ditches the bot commits and is at least more explicit than secret pre commit hooks that someone may or may not have configured.

[delhage]

OK.However it's done, maybe I should at least change the values file to add comments in a helm-docs friendly way for a start? Then we can decide later on how to implement the actual generation of the README.md.

[juriroemer]

Sounds good to me! I'll have someone look at options to generate the README.

We already generate the code reference for the website via gh actions on push, would it be sufficient for you to have the Helm README on the website instead of within the repository (we could of course link it from the main README). But that would mitigate the "you either have to run this locally or we'll have auto commits" problem.