Note:
This topic has been translated from a Chinese forum by GPT and might contain errors.Original topic: 设置配置项文档优化建议
|
username: Billmay表妹
- Issue Category: Incomplete Steps
- Pages where the issue appears:
https://docs.pingcap.com/zh/tidb/stable/tidb-configuration-file#tidb-configuration-file-description
https://docs.pingcap.com/zh/tidb/stable/tikv-configuration-file#tikv-configuration-file-description
https://docs.pingcap.com/zh/tidb/stable/tiflash-configuration#tiflash-configuration-parameters
https://docs.pingcap.com/zh/tidb/stable/pd-configuration-file#pd-configuration-file-description - Issue:
The “Configuration File Description” sections only describe the configuration items without indicating how to set them. In contrast, the “System Variables” section starts by explaining how to set variables. Many new users in the forum do not know how to set configuration items and post inquiries about it. This could be avoided by clearly describing it in the documentation.