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

Use helm-docs? #218

Open
maxnoe opened this issue Jan 30, 2025 · 0 comments
Open

Use helm-docs? #218

maxnoe opened this issue Jan 30, 2025 · 0 comments

Comments

@maxnoe
Copy link

maxnoe commented Jan 30, 2025

https://github.com/norwoodj/helm-docs

We use it with pre-commit to guarantee up-to-date readmes and we found it also integrates nicely into sphinx docs using myst-parser:

Helm Chart
==========


.. include:: ../chart/README.md
   :parser: myst_parser.sphinx_

You can add descriptions to values using magic comments, see the README of helm-docs.

It would be very nice if rucio could also adapt this, as the values of chart dependencies are included automatically when creating helm docs for parent charts.

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

No branches or pull requests

1 participant