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

* 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

11
scripts/helm-docs.sh Normal file
View file

@ -0,0 +1,11 @@
#!/bin/bash
## Reference: https://github.com/norwoodj/helm-docs
set -eux
CHART_DIR="$(cd "$(dirname "$0")/.." && pwd)"
echo "$CHART_DIR"
echo "Running Helm-Docs"
docker run \
-v "$CHART_DIR:/helm-docs" \
-u $(id -u) \
jnorwood/helm-docs:latest