Auto-document and require docs for values.yaml changes
Problem to solve
We need a simple, central place to document all the values.yaml fields.
Proposal
Add https://github.com/norwoodj/helm-docs as part of CI
- to provide a documented command to generate docs from
values.yamlinto the README - to test that the README did not change in an MR and ask to regenerate the README when needed
- change the link in https://docs.gitlab.com/ee/user/clusters/agent/install/#customize-the-helm-installation that links to the
values.yamlto link to the README
Edited by Viktor Nagy (GitLab)