Suggestions for Optimizing the Reading Experience of TiDB Configuration File Descriptions

Translated
1

Note:
This topic has been translated from a Chinese forum by GPT and might contain errors.

Original topic: TiDB配置文件描述阅读体验优化的建议

| username: OnTheRoad
  1. Documentation is unclear or incomplete, please submit according to the template below:
  • Issue Category: Poor documentation reading experience
  • Page where the issue occurs: TiDB 配置文件描述 | PingCAP 文档中心
    image
  • Issue: The order of the 4 optional values from low to high should be understood as follows, right?
    DELAYED<NO_PRIORITY<LOW_PRIORITY<HIGH_PRIORITY
    Why not directly list the value range in order of priority? For example:

“Optional values (from low to high): DELAYED, NO_PRIORITY, LOW_PRIORITY, HIGH_PRIORITY”

For this type of weight parameter values, wouldn’t it be better to use numbers directly?

  1. Are parameter values case-sensitive if they are strings?

The value range for the parameter opentracing.sampler.type is in lowercase, as shown below.
image
Link: https://docs.pingcap.com/zh/tidb/stable/tidb-configuration-file#type

Are these string parameters case-sensitive? It is not clearly marked.

2
| username: Billmay表妹 | Original post link

It has been reported to the relevant person in charge.

3
| username: Billmay表妹 | Original post link

Processed, the related PR can be seen at: update open-tracing tidb-configuration description by tangenta · Pull Request #10971 · pingcap/docs-cn · GitHub

4
| username: system | Original post link

This topic will be automatically closed 60 days after the last reply. No new replies are allowed.