Provide a description for each value that can be set

fonzdm / servarr

Just trying to make a Servarr helm chart. Help

GNU Affero General Public License v3.0

5 stars 1 forks source link

Provide a description for each value that can be set #12

Closed imgios closed 5 months ago

imgios commented 5 months ago

Description

Would be good to document all the values that can be set during the Helm Chart installation/update to customize it based on the user needs.

Solution you'd like

I think we can do it in several ways, and they are all good options at the end. Those are the ones I was thinking about:

Listing them in the README.md, but this would lead to a very long README and I don't like it so much;
Creating a new markdown file maybe in /docs (we should then add this path to the .helmignore) which will contains all the values with a short description, default value and an example.

Please, feel free to propose any other solution.

Code of Conduct

[X] I agree to follow this project's Code of Conduct

fonzdm commented 5 months ago

I got the importance of this issue, and I will work on it. Let's try your second idea and let's see what comes up 😄

fonzdm commented 5 months ago

Exploring the possibility to use this tool. There should be also an integration with pre-commit hooks, in order to automatically update docs for each helm modification. Let's see...

fonzdm commented 5 months ago

Did some tweaks using the tool, this is the first auto-generated README.md file for the chart. Setup the workflow actions to use. I will remove the needs-triage label and stark working on the proper documentation.

fonzdm commented 5 months ago

Let's be spicy and use:

git-push-user-name: "Servarr Bot 🤖"

as suggested by @imgios 😄

imgios commented 5 months ago

Did some tweaks using the tool, this is the first auto-generated README.md file for the chart. Setup the workflow actions to use. I will remove the needs-triage label and stark working on the proper documentation.

It looks really good to me. We just have to commment the parameters in the values.yaml like the following ones:

https://github.com/fonzdm/servarr/blob/a4f8e58da7d7f56e7c736eba1ceb70ae59db34b8/servarr/values.yaml#L1-L7

(but with a single hash # I guess)

fonzdm commented 5 months ago

Working on the issue, @imgios please can you take a look at this Reame? I am removing all the complex sections for the various services.. I have something in mind, but it will need another PR 😛 In fact, I think 99% of the services configuration is static, because it is a configuration of the subcharts that must not be modified by end users.. so I would like to only set anchors for the ingress class and fqdn of the services and stop there.

imgios commented 5 months ago

Working on the issue, @imgios please can you take a look at [this Reame]

It looks really promising! I like the idea to have the values split into different sections, nice one!

I am removing all the complex sections for the various services.. I have something in mind, but it will need another PR 😛

What are you thinking about? 👀

I think 99% of the services configuration is static, because it is a configuration of the subcharts that must not be modified by end users.. so I would like to only set anchors for the ingress class and fqdn of the services and stop there.

This sounds good, we can avoid to "expose" those static config to the user if it cannot be changed, otherwise people will only get confused.