Make docstrings for Helm values consistent across products
Open
Nobody has claimed this yet.
consistency
good first issue
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
There are various places where we have exactly (or essentially) the same setting but with a different docstring. We should strive for more consistency here and potentially make some overall documentation improvements along the way.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the repeated Helm values and their docstrings across the products covered by this repository. Compare equivalent settings, identify inconsistent wording, and define completion as consistent documentation plus any agreed broader improvements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100