Reorganize FAQ and troubleshoot related docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 1.2k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 31
Description
Change Request
This repository is ONLY used to solve problems related to DOCS-CN.
For other issues (TiDB, TiKV, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
- Describe what you find is inappropriate or missing in the existing docs.
https://docs.pingcap.com/zh/tidb/dev/tidb-faq
https://docs.pingcap.com/zh/tidb/dev/identify-slow-queries
FAQ 和故障诊断的内容 SW 期间加进来的时候有些乱，需要再拆分和优化
- Describe your suggestion or addition.
- Provide some reference materials (documents, websites, etc) if you could.
ref: Add missing tikv docs to TOC.md by Connor1996 · Pull Request #3574 · pingcap/docs-cn
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 by reading the linked FAQ and slow-query troubleshooting pages, then compare the organization with the referenced PR #3574. Clarify how the content should be split and optimized; done means the two documents have a coherent structure and the relevant navigation or references are updated.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100