Operator: Missing Descriptions for Many Properties
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 70
- Forks
- 176
- PR merge metrics
- No merged PRs in 30d
Description
The operator configuration example for TektonPipeline has an option for disable-home-env-overwrite, but does not provide a description of what this option does. There are several other items in the example configuration that likewise appear to have missing documentation.
Missing documentation makes it hard for humans and bots to provide accurate solutions to problems.
See https://tekton.dev/docs/operator/tektonpipeline/#properties
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 with the TektonPipeline properties section at https://tekton.dev/docs/operator/tektonpipeline/#properties and review the operator configuration example, beginning with disable-home-env-overwrite. Identify the other properties without descriptions and document what each option does; the properties section should no longer contain undocumented configuration items.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100