stackabletech / stackabletech/documentation
Operator env vars documentation
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 13
- Forks
- 14
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 10
Description
currently there is hand written docs for env vars and commandline parameters, but that in itself isn't useful.
The users want to set this with Helm, or somehow in OpenShift (or maybe with stackablectl?)
These things should go into the Reference section.
We should also think about maybe generating this if we can (but not necessary, as there are probably not that many settings). Maybe we can have instead common operator flags as a partial somewhere, that we can simply reference in all the operators.
related: https://github.com/stackabletech/documentation/issues/514
Contributor guide
No contributing guide indexed for this repository
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 existing hand-written environment-variable and command-line parameter documentation, then review the Reference sections and related issue 514. Done means the settings are documented in a form users can apply with Helm or OpenShift, with any decision about shared partials or generation recorded in the resulting documentation.
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
- Mostly clear
- Newbie friendliness
- 38/100