zalando / zalando/postgres-operator
Docs still ref configmap style of configuration
Open
Nobody has claimed this yet.
question
- Dominant language
- Go
- Stars
- 5.2k
- Forks
- 1.1k
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 3
Description
https://github.com/zalando/postgres-operator/blob/master/docs/reference/operator_parameters.md says the OperatorConfiguration is the new way of configuring the operator, yet the quickstart https://postgres-operator.readthedocs.io/en/latest/ references the config map when installing
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
Compare docs/reference/operator_parameters.md with the quickstart at postgres-operator.readthedocs.io/en/latest/. Update the quickstart's installation guidance so it no longer references the config map when OperatorConfiguration is the documented approach, then verify the rendered references and links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes, postgresql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100