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.

Sign up for GitHub

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

Jump to bottom

Update values.yaml documenting all configuration parameters #2

Open
sflandergan opened this issue Oct 1, 2019 · 0 comments
Open

Update values.yaml documenting all configuration parameters #2

sflandergan opened this issue Oct 1, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation hacktoberfest https://hacktoberfest.digitalocean.com

Comments

@sflandergan
Copy link
Member

Values.yaml currently contains quite some parameters, that are undocumented.

  • All configuration should be contained in the values.yml with an explanation, what they do
  • Documentation comments should start with two '#'
  • Documentation comments should start with the full qualified name of the parameter
  • Sample: ## ha.enabled if truea second stateful set running backups will be installed
@sflandergan sflandergan added hacktoberfest https://hacktoberfest.digitalocean.com documentation Improvements or additions to documentation labels Oct 1, 2019
@sflandergan sflandergan mentioned this issue Oct 1, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation hacktoberfest https://hacktoberfest.digitalocean.com
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sflandergan