pingcap / pingcap/tidb-operator
Documentation for operator features
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 1.3k
- Forks
- 540
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 18
Description
Feature Request
Documentation for operator features:
We see that TiDB supports features like
- AdvancedStatefulSet
- VolumeModifying
- VolumeReplacing
But don't see any proper documentation around these features and the use cases that can be addressed using these features.
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 existing documentation and implementation entry points for AdvancedStatefulSet, VolumeModifying, and VolumeReplacing. Document each feature's behavior and the use cases it supports, with examples where the existing project material provides them; done means users can understand and use all three features.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation, infrastructure
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100