Skip to content

Commit

Permalink
📝 update doc template + gen
Browse files Browse the repository at this point in the history
  • Loading branch information
vmdude committed Jun 12, 2024
1 parent d8d0c56 commit d1893e8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions charts/atlantis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ extraManifests:
| initConfig.script | string | Check values.yaml. | Script to run on the init container. |
| initConfig.securityContext | object | `{}` | Security context for the container. |
| initConfig.sharedDir | string | `"/plugins"` | SharedDir is set as env var INIT_SHARED_DIR. |
| initConfig.sharedDirReadOnly | bool | `true` | |
| initConfig.sizeLimit | string | `"100Mi"` | Size for the shared volume. |
| initConfig.workDir | string | `"/tmp"` | |
| initContainers | list | `[]` | Optionally specify init containers manifests to be added to the Atlantis pod. Check values.yaml for examples. |
Expand Down Expand Up @@ -384,9 +385,9 @@ To perform a smoke test of the deployment (i.e. ensure that the Atlantis UI is u

## Update documentation

Documentations is auto-generated using [helm-docs](https://github.com/norwoodj/helm-docs).
Documentation is auto-generated using [helm-docs](https://github.com/norwoodj/helm-docs).

To update run the follwogin (from the root path of the repository):
To update run the following (from the root path of the repository):

1. If required, update `charts/atlantis/README.md.gotmpl`
2. Run `make docs`
Expand Down
4 changes: 2 additions & 2 deletions charts/atlantis/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -219,9 +219,9 @@ To perform a smoke test of the deployment (i.e. ensure that the Atlantis UI is u

## Update documentation

Documentations is auto-generated using [helm-docs](https://github.com/norwoodj/helm-docs).
Documentation is auto-generated using [helm-docs](https://github.com/norwoodj/helm-docs).

To update run the follwogin (from the root path of the repository):
To update run the following (from the root path of the repository):

1. If required, update `charts/atlantis/README.md.gotmpl`
2. Run `make docs`
Expand Down

0 comments on commit d1893e8

Please sign in to comment.