pingcap / pingcap/docs-tidb-operator
Missing DM not natively supported in operator v2 and a v1-v2 gap
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 52
- Forks
- 129
- Avg merge
- 12m
- Merged PRs (30d)
- 2
Description
Change Request
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
- Describe what you find is inappropriate or missing in the existing docs.
DM is not natively supported in V2. Is not included in v1 - v2 documentations gaps
- Describe your suggestion or addition.
Add DM as a documentation gap. Make sure all of the gaps on this page have items in operator v2 roadmap linked from main operator page.
- Provide some reference materials (documents, websites, etc) if you could.
The main operator page lists this as the link for v2 roadmap:
https://github.com/pingcap/tidb-operator/tree/main/docs/rfcs
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 with the existing v1-v2 documentation gaps page and the main operator page's v2 roadmap link to the docs/rfcs directory. Add DM as a documented gap and verify that every gap listed on the page has a corresponding item in the Operator v2 roadmap.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100