awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-10-06 13:27:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): chart documentation generation

Browse Source
This commit is contained in:
Grraahaam
2023-02-15 09:43:17 +01:00
parent f28a2ea151
commit b5d4cfed03
2 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
helm-charts/README.md
+2 -1
View File
@@ -28,8 +28,9 @@ Here's the link to our charts corresponding documentation :
We're trying to follow a documentation convention across our charts, allowing us to auto-generate markdown documentation thanks to [this tool](https://github.com/bitnami-labs/readme-generator-for-helm) We're trying to follow a documentation convention across our charts, allowing us to auto-generate markdown documentation thanks to [this tool](https://github.com/bitnami-labs/readme-generator-for-helm)
Steps to update the documentation : Steps to update the documentation :
1. `cd helm-charts/<chart>`
1. `git clone https://github.com/bitnami-labs/readme-generator-for-helm` 1. `git clone https://github.com/bitnami-labs/readme-generator-for-helm`
2. `npm install ./readme-generator-for-helm` 2. `npm install ./readme-generator-for-helm`
3. `npm exec readme-generator -- --readme <chart>/README.md --values <chart>/values.yaml` 3. `npm exec readme-generator -- --readme README.md --values values.yaml`
- It'll insert the table below the `## Parameters` title - It'll insert the table below the `## Parameters` title
- It'll output errors if some of the path aren't documented - It'll output errors if some of the path aren't documented
helm-charts/infisical/.gitignore
+3 -1
View File
@@ -1 +1,3 @@
charts/ charts/
node_modules/
package*.json