supabase-kubernetes icon indicating copy to clipboard operation
supabase-kubernetes copied to clipboard

Added helm-docs for generating chart parameters documentation

Open braveokafor opened this issue 1 year ago • 1 comments

What kind of change does this PR introduce?

feature/ docs update

What is the current behavior?

Currently, users had to navigate through the values.yaml file to locate Chart parameters.
This PR helps address the issue raised here https://github.com/supabase-community/supabase-kubernetes/issues/3.

What is the new behavior?

With this update, the Chart parameters documentation is now available in README.md.
A helm-docs template (README.md.gotmpl), has been added for generating the README from values.yaml.

Additional context

The comments in values.yaml have been updated to use the helm-docs syntax.
To sync values.yaml with README.md, execute the following command:

helm-docs -t README.md.gotmpl -o README.md -b for-the-badge.

To make changes to the base README, modifications should be made to README.md.gotmpl.

A live example of the updated README is available here

braveokafor avatar May 25 '24 11:05 braveokafor

Just bumped chart version to 0.1.3.
Should fix ct-lint action failure.

braveokafor avatar Jun 04 '24 16:06 braveokafor