Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use helm-docs to automatically generate Helm docs #2044

Closed
lucacome opened this issue May 28, 2024 · 0 comments · Fixed by #2058
Closed

Use helm-docs to automatically generate Helm docs #2044

lucacome opened this issue May 28, 2024 · 0 comments · Fixed by #2058
Assignees
@lucacome
Labels
documentation Improvements or additions to documentation helm-chart Relates to helm chart
Milestone
v1.3.0

Comments

@lucacome
Copy link
Member

lucacome commented May 28, 2024 •
edited
Loading

Problem: It's hard to keep the README up-to-date and it's a manual process

Solution: Use https://github.com/norwoodj/helm-docs to automatically generate the docs from the values.yaml file
@lucacome lucacome mentioned this issue May 28, 2024
Open
@lucacome lucacome self-assigned this May 28, 2024
@lucacome lucacome mentioned this issue May 29, 2024
Merged
6 tasks
@mpstefan mpstefan added documentation Improvements or additions to documentation helm-chart Relates to helm chart labels Jun 3, 2024
@mpstefan mpstefan added this to the v1.3.0 milestone Jun 3, 2024
@mpstefan mpstefan moved this from 🆕 New to 🏗 In Progress in NGINX Gateway Fabric Jun 3, 2024
@lucacome lucacome moved this from 🏗 In Progress to 👀 In Review in NGINX Gateway Fabric Jun 4, 2024
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in NGINX Gateway Fabric Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lucacome lucacome

Labels
documentation Improvements or additions to documentation helm-chart Relates to helm chart
Projects
NGINX Gateway Fabric
Archived in project
Milestone
v1.3.0
Development

Successfully merging a pull request may close this issue.

Use helm-docs to automatically generate Helm docs lucacome/nginx-kubernetes-gateway
2 participants
@lucacome @mpstefan