TiDB Documentation

Welcome to 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.

Currently, the official documentation supports two languages:

• en: documentation in English
• zh: documentation in Chinese

You can use Google Translate to view the documentation in different languages. For example:

• fr: documentation in French
• ja: documentation in Japanese
• ko: documentation in Korean

Documentation versions

Currently, we maintain the following versions of TiDB documentation in different branches:

Branch name	TiDB docs version
master	The latest development version
release-6.0	6.0 Development Milestone Release
release-5.4	5.4 stable version
release-5.3	5.3 stable version
release-5.2	5.2 stable version
release-5.1	5.1 stable version
release-5.0	5.0 stable version
release-4.0	4.0 stable version
release-3.1	3.1 stable version
release-3.0	3.0 stable version
release-2.1	2.1 stable version

Contributing

See TiDB Documentation Contributing Guide to become a contributor! 🤓