Use helm-docs to document params in README.md

[mkilchhofer]

I'd like to introduce https://github.com/norwoodj/helm-docs for documenting the possible parameters.

Use-Case

It's hard to follow if every param is up-to-date on a PR. We at argo-helm use helm-docs to mitigate this.

Specification

• Update values.yaml with helm-docs comment above each key/param
• Introduce helm-docs
• Update contributor docs about helm-docs

[zroubalik]

Sounds good, thanks! Any improvement on Helm charts is more then welcome!

[JorTurFer]

Your PRs look awesome, I need some time to review the tool and how it works, but they are promising ❤️
Thanks for them!

[tomkerkhove]

Thanks for the PRs; I merged one but added comment here: https://github.com/kedacore/charts/pull/447/files#r1222944083

Once that is clear we can tweak it further!

Would you mind opening a PR to the contribution guide to document how this works and how to generate things please?

[mkilchhofer]

I answered in the mentioned PR.

Regarding how to use it, I already made a description in the CONTRIBUTING.md (it's part ot the keda PR)

[tomkerkhove]

Regarding how to use it, I already made a description in the CONTRIBUTING.md (it's part ot the keda PR)

Oh OK, my bad. I was waiting to review that one until the HTTP one is in since it's smaller