From b5d4cfed03a5276dbc58e8b1621a364db30c4564 Mon Sep 17 00:00:00 2001 From: Grraahaam <72856427+Grraahaam@users.noreply.github.com> Date: Wed, 15 Feb 2023 09:43:17 +0100 Subject: [PATCH] chore(docs): chart documentation generation --- helm-charts/README.md | 3 ++- helm-charts/infisical/.gitignore | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/helm-charts/README.md b/helm-charts/README.md index 8449243de..01675d0b2 100644 --- a/helm-charts/README.md +++ b/helm-charts/README.md @@ -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) Steps to update the documentation : +1. `cd helm-charts/` 1. `git clone https://github.com/bitnami-labs/readme-generator-for-helm` 2. `npm install ./readme-generator-for-helm` -3. `npm exec readme-generator -- --readme /README.md --values /values.yaml` +3. `npm exec readme-generator -- --readme README.md --values values.yaml` - It'll insert the table below the `## Parameters` title - It'll output errors if some of the path aren't documented \ No newline at end of file diff --git a/helm-charts/infisical/.gitignore b/helm-charts/infisical/.gitignore index 711a39c54..a2968aad7 100644 --- a/helm-charts/infisical/.gitignore +++ b/helm-charts/infisical/.gitignore @@ -1 +1,3 @@ -charts/ \ No newline at end of file +charts/ +node_modules/ +package*.json \ No newline at end of file