Skip to content
Snippets Groups Projects
Commit aaf11f40 authored by Nacho Barrientos's avatar Nacho Barrientos
Browse files

Explain how to change the documentation in the contributing guide

parent 41bfaa75
No related branches found
No related tags found
1 merge request!57Use only Helm docs plus other misc fixes
...@@ -28,7 +28,7 @@ See [getting started](docs/getting_started.md) for hints on how to install the c ...@@ -28,7 +28,7 @@ See [getting started](docs/getting_started.md) for hints on how to install the c
This procedure ensures that your changes do not introduce any unintended issues. This procedure ensures that your changes do not introduce any unintended issues.
### 4. Update Documentation ### 4. Update Documentation
If your changes modify or extend the functionality of the chart, do not forget to update the relevant documentation (such as `README.md`, `docs/values.md` or any related configuration files) to reflect these modifications. If your changes modify or extend the functionality of the chart, do not forget to update the relevant documentation. `README.md` is autogenerated using [helm-docs](https://github.com/norwoodj/helm-docs) so please don't edit this file by hand (modify instead `values.yaml` or `README.md.gotmpl` as needed). Then re-generate the final `README.md` using helm-docs and add those changes too to your change request.
### 5. Submit a Merge Request ### 5. Submit a Merge Request
Once your changes are ready, push your branch to your fork and create a Merge Request (MR) targeting the `master` branch of the main repository. Once your changes are ready, push your branch to your fork and create a Merge Request (MR) targeting the `master` branch of the main repository.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment