Add `Cloud-Only` and `OP-Only` notation or comment for some document
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 617
- Forks
- 724
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 223
Description
Change Request
Please answer the following questions before submitting your issue. Thanks!
-
Describe what you find is inappropriate or missing in the existing docs.
Sometimes it is confusing for users whether a doc is applicable to TiDB Cloud. For example, TiDB-Lightning Physical mode, it is OP only. -
Describe your suggestion or addition.
For the docs which are only applicable to OP deployment, add notes there. -
Provide some reference materials (such as documents and websites) if you could.
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 reviewing the documentation around TiDB-Lightning Physical mode and other deployment-specific pages. Identify documents that apply only to TiDB Cloud or only to on-premises (OP) deployments, then add clear Cloud-Only or OP-Only notes where needed. Done means affected documents visibly state their deployment scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100