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.

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

Generate helm-docs readme for all charts #430

Open
Allex1 opened this issue Oct 15, 2022 · 5 comments
Open

Generate helm-docs readme for all charts #430

Allex1 opened this issue Oct 15, 2022 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@Allex1
Copy link
Contributor

Allex1 commented Oct 15, 2022

@TylerHelmuth @dmitryax I was thinking to add helm-docs for all of our chart like Grafana charts have for example. We use them in all charts and I find it very useful. I can also add contributing instructions for users to keep them in sync when they make changes in values.yaml. WDYT ?

@Allex1 Allex1 self-assigned this Oct 15, 2022
@dmitryax
Copy link
Member

Sounds good to me 👍

@TylerHelmuth
Copy link
Member

Agreed. Id say we should add something to the workflows that enforces things stay in sync, like we do with examples.

@TylerHelmuth TylerHelmuth added the enhancement New feature or request label Oct 19, 2022
@Saki042
Copy link

Saki042 commented Jun 13, 2024

@TylerHelmuth , Can you confirm whether this enhancement requirement is still open ?

@TylerHelmuth
Copy link
Member

Yes this would still be helpful

@Saki042
Copy link

Saki042 commented Jun 14, 2024

@Allex1 / @TylerHelmuth , Can you elaborate more on the issue and I am new to open source so it would be really helpful if you provide me some guide regarding changes.
Can you please assign it to me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants