DevFW-CICD/argocd-helm
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(all): Add Documentation Guidelines (#1099)

Browse source 
* feat(all): Add Documentation Guidelines

Signed-off-by: Oliver Bähler <oliverbaehler@hotmail.com>

* Satisfy Linter

Signed-off-by: Oliver Bähler <oliverbaehler@hotmail.com>

* Apply changes from code review

Signed-off-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com>

* fix: Also add *.gotmpl to argo-rollouts/.helmignore

Signed-off-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com>

Co-authored-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com>
This commit is contained in:
Oliver Bähler 2022-01-24 20:18:51 +01:00 • committed by GitHub
parent 2b830deaa4
commit 752e1c0580
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 52 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

14
CONTRIBUTING.md
View file

@ -48,6 +48,20 @@ annotations:
- "[Security]": Some Security Patch was included"
```
## Documentation
The documentation for each chart is done with [helm-docs](https://github.com/norwoodj/helm-docs). This way we can ensure that values are consistent with the chart documentation.
We have a script on the repository which will execute the helm-docs docker container, so that you don't have to worry about downloading the binary etc. Simply execute the script (Bash compatible, might require sudo privileges):
```
bash scripts/helm-docs.sh
```
**NOTE**: When creating your own `README.md.gotmpl`, don't forget to add it to your `.helmignore` file.
# Testing
## Testing Argo Workflows Changes