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

Add the (Automated) Chart Documentation #14

Merged
merged 85 commits into from
Apr 12, 2024
Merged

Conversation

fonzdm
Copy link
Owner

@fonzdm fonzdm commented Apr 12, 2024

  • Please check if the PR fulfills these requirements
  • The branch naming convention follows our guidelines
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

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 🤖"

  • What is the current behavior? (You can also link to an open issue here)

No documentation exists for the chart.

  • What is the new behavior (if this is a feature change)?

Everytime someone touches the chart, the documentation is produced/updated.
Users can follow the documentation to fill a values.yaml file for their deployments.

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

It's not a breaking change but it's a core functionality.

  • Other information:

Some other refactoring will be done to the values.yaml, but it is not in scope of this PR.

Closes #12

@fonzdm fonzdm added the documentation Improvements or additions to documentation label Apr 12, 2024
@fonzdm fonzdm requested a review from imgios April 12, 2024 13:55
@fonzdm fonzdm linked an issue Apr 12, 2024 that may be closed by this pull request
1 task
@fonzdm
Copy link
Owner Author

fonzdm commented Apr 12, 2024

Let me fix that linting pipeline.

Copy link
Collaborator

@imgios imgios left a 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.

servarr/README.md Outdated Show resolved Hide resolved
servarr/README.md Show resolved Hide resolved
.github/workflows/pre-commit-hooks.yaml Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
.github/workflows/pre-commit-hooks.yaml Outdated Show resolved Hide resolved
@fonzdm
Copy link
Owner Author

fonzdm commented Apr 12, 2024

@imgios please check, everything resolved.

@imgios
Copy link
Collaborator

imgios commented Apr 12, 2024

@imgios please check, everything resolved.

Thank you for taking care of it. Everything seems to be fine, going to merge it into dev 🚀

@imgios imgios merged commit d08a0a6 into dev Apr 12, 2024
@imgios imgios deleted the docs/values-description branch April 12, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide a description for each value that can be set
2 participants