配置：关于 gRPC 参数描述不准确含义模糊
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 1.2k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 31
Description
Error 报告
This repository is ONLY used to solve problems related to DOCS-CN.
For other issues (TiDB, TiKV, etc), please move to other repositories.
tidb 配置中
https://docs.pingcap.com/zh/tidb/stable/tidb-configuration-file#grpc-keepalive-time
和
https://docs.pingcap.com/zh/tidb/stable/tidb-configuration-file#grpc-keepalive-timeout
相关描述不清晰。
应当参考
https://pkg.go.dev/google.golang.org/grpc/keepalive#ClientParameters
gRPC 文档描述进行描述
Please answer the following questions before submitting your issue. Thanks!
- What is the document directory for the problem?
如上
- How would you like to improve it?
修改对应描述
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 TiDB configuration file documentation at the linked gRPC keepalive-time and keepalive-timeout anchors, then compare their descriptions with the gRPC ClientParameters documentation. Update the two descriptions so their meanings are accurate and clear, and verify that both anchors present the intended configuration semantics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- grpc
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100