Use only Helm docs plus other misc fixes
The main goal of this change is to make sure that there's only one source of truth for the documentation of the values, instead of having values.yaml
and docs/values.md
playing in different leagues. For this I'm switching the documentation tooling to use helm-docs.
The patchset also includes the following:
- Fix typos and some wording.
- Make sure that the scrapping interval options for the Kube and Node exporters are actually honored (values themselves kept)
- Remove logs' scrapping interval as I think it's a c&p artifact.
- Finish the job started by c40c0044 by adding an extra missing CI rule for the
helm_lint
job.
Edited by Nacho Barrientos
Merge request reports
Activity
added 1 commit
- 76dd720e - Only display the long description in the README
added 1 commit
- 47d0def5 - Only display the long description in the README
added 1 commit
- a58cc4a8 - Add CI job to fail if README.md needs to be regenerated
added 1 commit
- 723ccccd - Add CI job to fail if README.md needs to be regenerated
added 1 commit
- 4e4a3216 - Add CI job to fail if README.md needs to be regenerated
added 1 commit
- d7cb0e25 - Add CI job to fail if README.md needs to be regenerated
added 1 commit
- 503aec05 - Add CI job to fail if README.md needs to be regenerated
added 10 commits
- bdf38aa9 - Use only helm-docs, using values.yaml as the only source of truth
- 843734b7 - Add CI job to fail if README.md needs to be regenerated
- 677e838c - Fix typo
- 54007545 - Explain how to change the documentation in the contributing guide
- 12a10d50 - Actually honour scrapping interval configuration
- e8c20d71 - Remove unused key
- 510ca6f5 - Reword chart's short description
- 6e9d909f - Only display the long description in the README
- e2ff1d96 - Align documentation section to reality
- 3d6a8364 - Add missing CI rule
Toggle commit listadded 10 commits
- b33f35a7 - Use only helm-docs, using values.yaml as the only source of truth
- 5be7a38e - Add CI job to fail if README.md needs to be regenerated
- fbee57c3 - Fix typo
- 02c31b37 - Explain how to change the documentation in the contributing guide
- c47cad62 - Actually honour scrapping interval configuration
- 9885c244 - Remove unused key
- e88fa9c9 - Reword chart's short description
- a0977f68 - Only display the long description in the README
- e4670377 - Align documentation section to reality
- dbdbdb4c - Add missing CI rule
Toggle commit listadded 10 commits
- 5e81fced - Use only helm-docs, using values.yaml as the only source of truth
- e15e7e88 - Add CI job to fail if README.md needs to be regenerated
- 41bfaa75 - Fix typo
- aaf11f40 - Explain how to change the documentation in the contributing guide
- e2654898 - Actually honour scrapping interval configuration
- 095f0e78 - Remove unused key
- 1fd74afc - Reword chart's short description
- cff9b21e - Only display the long description in the README
- 74ca4045 - Align documentation section to reality
- 52233a6a - Add missing CI rule
Toggle commit list
Please register or sign in to reply