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

Support for creating docs of named templates in library charts #165

Open
stoetti opened this issue Nov 9, 2022 · 1 comment
Open

Support for creating docs of named templates in library charts #165

stoetti opened this issue Nov 9, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@stoetti
Copy link

stoetti commented Nov 9, 2022

We are using library charts to distribute common templates using the named template feature of helm. As the number of development teams and new developers grow the documentation of those templates becomes more and more important.

Therefore, it would be great if the documentation of those templates could be generated just like the doc of the possible values. The default helm chart's _helper.tpl file includes documentation headers for each named template which would be a good starting point for defining a convention how to determine the right documentation for the right template.

@thepaulmacca
Copy link

I've been thinking about this as well - would love to know if anyone out there has come up with a way of doing it!

@Nepo26 Nepo26 added the enhancement New feature or request label Jun 29, 2023
@Nepo26 Nepo26 added this to the General Cleanup milestone Jul 25, 2023
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
Status: No status
Development

No branches or pull requests

3 participants