TiDB Documentation
This repository stores all the source files of TiDB Docs at the PingCAP website, while the pingcap/docs-cn repository stores all the source files of TiDB Documentation in Chinese. If you find documentation issues, feel free to create an Issue to let us know or directly create a Pull Request to help fix or update it.
Docs structure
The general TiDB documentation structure is as follows:
├── TOC.md
├── how-to
├── get-started
├── deploy
├── orchestrated
├── ansible.md
├── offline-ansible.md
├── docker.md
├── configure
├── maintain
├── troubleshoot
├── ...
├── reference
├── tools
├── tidb-binlog
├── ...
├── releases
├── tidb-in-kubernetes
├── faq
├── ...
...
Contributing
See TiDB Documentation Contributing Guide to get started. 🤓