docs

docs

TiDB database documentation. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics. Try AI-powered Chat2Query free at : https://www.pingcap.com/tidb-serverless/

Stars: 583

Visit
 screenshot

The TiDB Documentation repository contains the source files for TiDB Docs in English and Chinese. Users can contribute by creating issues or pull requests to improve the documentation. It also provides guidance on customizing and generating PDF versions of the documentation. The repository maintains various versions of TiDB documentation in different branches, including development milestone releases and long-term support versions. Contributors can refer to the Contributing Guide to become a part of the project. The documentation is licensed under CC BY-SA 3.0.

README:

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 name TiDB docs version
master The latest development version
release-8.3 8.3 Development Milestone Release
release-8.2 8.2 Development Milestone Release
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
release-6.0 6.0 Development Milestone Release (Archived documentation, no longer updated)
release-5.4 5.4 stable version
release-5.3 5.3 stable version
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

contribution-map

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.

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for docs

Similar Open Source Tools

For similar tasks

For similar jobs