AUTO_RANDOM doc says 'number of storage engines' when it should be number of TiKV nodes
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 617
- Forks
- 724
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 223
Description
Error Report
Please answer the following questions before submitting your issue. Thanks!
-
What is the URL/path of the document related to this issue?
https://docs.pingcap.com/tidb/stable/auto-random -
How would you like to improve it?
Change:
The best practice is to set the shard bits as log(2, x), in which x is the current number of storage engines.
to
The best practice is to set the shard bits as log(2, x), in which x is the current number of TiKV nodes.
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
Open the stable auto-random document at the linked URL and find the sentence describing the recommended shard bits. Replace “current number of storage engines” with “current number of TiKV nodes,” then review the rendered page to confirm the wording is correct.
Written by the indexing model from the issue text.
Assessment
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100