1. Project Overview & Quickstart (pingcap/tidb)
TiDB Documentation Hub
A comprehensive hub for TiDB documentation, including developer guides and user manuals for the latest releases. This file provides structured access to key information for both developers and users of the TiDB distributed SQL database.
This document serves as a central point of reference for accessing various TiDB documentation resources. It aims to streamline the process of finding relevant information, from in-depth developer guides to user-focused manuals and release notes for the most current versions of TiDB.
Developer Resources
- TiDB Developer Guide: Comprehensive guide for TiDB development, covering architecture, contribution guidelines, and advanced topics.
- Uber Go Style Guide: Official style guide for Go programming at Uber.
User Manuals
- TiDB Documentation Manifest: Top-level documentation manifest linking to product, developer, API, best-practice, and release-note manifests.
- TiUP Documentation Map: Guides you through TiUP documentation with links and introductions.
2. Official Technical Reference & Guides (pingcap/docs)
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:
fr: documentation in Frenchja: documentation in Japaneseko: documentation in Koreande: documentation in Germanes: documentation in Spanish
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-8.5 |
8.5 LTS (Long-Term Support) |
release-8.4 |
8.4 Development Milestone Release (Archived documentation, no longer updated) |
release-8.3 |
8.3 Development Milestone Release (Archived documentation, no longer updated) |
release-8.2 |
8.2 Development Milestone Release (Archived documentation, no longer updated) |
release-8.1 |
8.1 LTS (Long-Term Support) |
release-8.0 |
8.0 Development Milestone Release (Archived documentation, no longer updated) |
release-7.6 |
7.6 Development Milestone Release (Archived documentation, no longer updated) |
release-7.5 |
7.5 LTS (Long-Term Support) |
release-7.4 |
7.4 Development Milestone Release (Archived documentation, no longer updated) |
release-7.3 |
7.3 Development Milestone Release (Archived documentation, no longer updated) |
release-7.2 |
7.2 Development Milestone Release (Archived documentation, no longer updated) |
release-7.1 |
7.1 LTS (Long-Term Support) version |
release-7.0 |
7.0 Development Milestone Release (Archived documentation, no longer updated) |
release-6.6 |
6.6 Development Milestone Release (Archived documentation, no longer updated) |
release-6.5 |
6.5 LTS (Long-Term Support) version |
release-6.4 |
6.4 Development Milestone Release (Archived documentation, no longer updated) |
release-6.3 |
6.3 Development Milestone Release (Archived documentation, no longer updated) |
release-6.2 |
6.2 Development Milestone Release (Archived documentation, no longer updated) |
release-6.1 |
6.1 LTS (Long-Term Support) version (Archived documentation, no longer updated) |
release-6.0 |
6.0 Development Milestone Release (Archived documentation, no longer updated) |
release-5.4 |
5.4 stable version (Archived documentation, no longer updated) |
release-5.3 |
5.3 stable version (Archived documentation, no longer updated) |
release-5.2 |
5.2 stable version (Archived documentation, no longer updated) |
release-5.1 |
5.1 stable version (Archived documentation, no longer updated) |
release-5.0 |
5.0 stable version (Archived documentation, no longer updated) |
release-4.0 |
4.0 stable version (Archived documentation, no longer updated) |
release-3.1 |
3.1 stable version (Archived documentation, no longer updated) |
release-3.0 |
3.0 stable version (Archived documentation, no longer updated) |
release-2.1 |
2.1 stable version (Archived documentation, no longer updated) |
Contributing
See TiDB Documentation Contributing Guide to become a contributor! 🤓
License
All documentation starting from TiDB v7.0 is available under the terms of CC BY-SA 3.0.