Awesome

TiDB on Kubernetes Documentation

This repository stores all the source files of TiDB on Kubernetes documentation at the PingCAP website. That is, the documentation for TiDB Operator.

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:

Documentation versions

Currently, we maintain the following versions for TiDB on Kubernetes documentation, each with a separate branch:

Branch name	Version description
`master`	the latest development version
`release-1.6`	the 1.6 version
`release-1.5`	the 1.5 version (latest stable)
`release-1.4`	the 1.4 version
`release-1.3`	the 1.3 version
`release-1.2`	the 1.2 version
`release-1.1`	the 1.1 version (archived)
`release-1.0`	the 1.0 version (archived)

Note:

Previously, we maintain the TiDB on Kubernetes documentation in the docs and docs-cn repository.

Since March 31, 2020, all the TiDB on Kubernetes documentation has been moved to this repository, and maintained based on versions in the branches above.

License

All documentation starting from TiDB Operator v1.5 is available under the terms of CC BY-SA 3.0.