Home

Awesome

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.

If you want to locally customize and output TiDB documentation in PDF format to meet the needs of specific scenarios, such as freely sorting or deleting certain contents in TiDB documentation, please refer to TiDB Documentation PDF Generation Tutorial.

Currently, the official documentation supports two languages:

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

Documentation versions

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

Branch nameTiDB docs version
masterThe latest development version
release-8.58.5 LTS (Long-Term Support)
release-8.48.4 Development Milestone Release
release-8.38.3 Development Milestone Release
release-8.28.2 Development Milestone Release (Archived documentation, no longer updated)
release-8.18.1 LTS (Long-Term Support)
release-8.08.0 Development Milestone Release (Archived documentation, no longer updated)
release-7.67.6 Development Milestone Release (Archived documentation, no longer updated)
release-7.57.5 LTS (Long-Term Support)
release-7.47.4 Development Milestone Release (Archived documentation, no longer updated)
release-7.37.3 Development Milestone Release (Archived documentation, no longer updated)
release-7.27.2 Development Milestone Release (Archived documentation, no longer updated)
release-7.17.1 LTS (Long-Term Support) version
release-7.07.0 Development Milestone Release (Archived documentation, no longer updated)
release-6.66.6 Development Milestone Release (Archived documentation, no longer updated)
release-6.56.5 LTS (Long-Term Support) version
release-6.46.4 Development Milestone Release (Archived documentation, no longer updated)
release-6.36.3 Development Milestone Release (Archived documentation, no longer updated)
release-6.26.2 Development Milestone Release (Archived documentation, no longer updated)
release-6.16.1 LTS (Long-Term Support) version
release-6.06.0 Development Milestone Release (Archived documentation, no longer updated)
release-5.45.4 stable version
release-5.35.3 stable version (Archived documentation, no longer updated)
release-5.25.2 stable version (Archived documentation, no longer updated)
release-5.15.1 stable version (Archived documentation, no longer updated)
release-5.05.0 stable version (Archived documentation, no longer updated)
release-4.04.0 stable version (Archived documentation, no longer updated)
release-3.13.1 stable version (Archived documentation, no longer updated)
release-3.03.0 stable version (Archived documentation, no longer updated)
release-2.12.1 stable version (Archived documentation, no longer updated)

Contributing

<img src="media/contribution-map.png" alt="contribution-map" width="180"></img>

See TiDB Documentation Contributing Guide to become a contributor! 🤓

<a href="https://next.ossinsight.io/widgets/official/compose-recent-active-contributors?repo_id=63995402&limit=30" target="_blank" style="display: block;" align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-recent-active-contributors/thumbnail.png?repo_id=63995402&limit=30&image_size=auto&color_scheme=dark" width="655" height="auto" /> <img alt="Active Contributors of pingcap/docs - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-recent-active-contributors/thumbnail.png?repo_id=63995402&limit=30&image_size=auto&color_scheme=light" width="655" height="auto" /> </picture> </a>

License

All documentation starting from TiDB v7.0 is available under the terms of CC BY-SA 3.0.