-
-
Notifications
You must be signed in to change notification settings - Fork 1
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
Add the (Automated) Chart Documentation #14
Conversation
Let me fix that linting pipeline. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @fonzdm, just finished to look at it and I leaved some questions all around. Please, let me know your POV.
@imgios please check, everything resolved. |
Thank you for taking care of it. Everything seems to be fine, going to merge it into |
An auto-generated documentation for the chart is introduced with this PR.
The documentation is produced based on comments of the values.yaml file, and the overall chart structure.
A pipeline takes care of fetching the chart changes and update the documentation with a dedicated commit, authored "Servarr Bot 🤖"
No documentation exists for the chart.
Everytime someone touches the chart, the documentation is produced/updated.
Users can follow the documentation to fill a values.yaml file for their deployments.
It's not a breaking change but it's a core functionality.
Some other refactoring will be done to the
values.yaml
, but it is not in scope of this PR.Closes #12