TiKV Configuration File: The dependencies between parameters should be clearly described
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/tikv-configuration-file/ -
How would you like to improve it?
For example, there is one known rule for following three parameters:
raft-base-tick-interval * raft-election-timeout-ticks should > raft-store-max-leader-lease
If this condition is not met, TiKV will fail to start.
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 with the TiKV configuration document at https://docs.pingcap.com/tidb/stable/tikv-configuration-file/ and review how the listed raft parameters are currently described. Identify the parameter dependencies that need documenting, including the provided inequality, and finish when the relevant configuration guidance clearly states the constraints and startup impact.
Written by the indexing model from the issue text.
Assessment
- Domain
- databases, distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100