fonzdm / servarr

Servarr - Stack Deployment with Helm
GNU Affero General Public License v3.0
6 stars 1 forks source link

Add the (Automated) Chart Documentation #14

Closed fonzdm closed 7 months ago

fonzdm commented 7 months ago

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

fonzdm commented 7 months ago

Let me fix that linting pipeline.

fonzdm commented 7 months ago

@imgios please check, everything resolved.

imgios commented 7 months ago

@imgios please check, everything resolved.

Thank you for taking care of it. Everything seems to be fine, going to merge it into dev πŸš€