pingcap

docs-cn

Database#TiDB#Documentation#Distributed Database#SQL

1,835

// summary

This repository stores the source files for the TiDB Chinese documentation on the PingCAP official website, covering detailed technical documentation from development versions to various historical releases. Users can participate in the maintenance and improvement of the documentation by submitting Issues or Pull Requests. Additionally, the repository provides tutorials for self-generating customized PDF documents to meet specific usage requirements.

// technical analysis

The TiDB documentation repository is the source file repository for PingCAP's official Chinese documentation, utilizing a versioned management architecture based on Git branches to ensure that documentation strictly corresponds to different release versions of the TiDB database. This project addresses the challenges of maintaining and updating documentation for complex distributed databases through an open-source collaboration model, allowing community members to participate directly in documentation optimization via Issues and Pull Requests. Its core design trade-off lies in isolating documentation versions of different lifecycles through branching, which supports both active development version maintenance and provides a stable reference basis for archived older versions.

// key highlights

Provides multi-version branch management to ensure documentation precisely matches various TiDB development milestones and long-term support versions.

Supports a community-driven contribution model, where users can participate directly in improving documentation content by submitting Pull Requests.

Provides tutorials for self-generating PDFs, making it convenient for users to customize and filter documentation content according to specific needs.

Features a clear archiving mechanism that explicitly identifies documentation versions that are no longer updated, reducing the risk of users obtaining outdated information.

Adopts the CC BY-SA 3.0 license, which standardizes the open-source usage and distribution rights of the documentation content.

// use cases

Consult technical documentation for different versions of TiDB

Contribute documentation content via Pull Requests

Self-customize and generate documents in PDF format

// getting started

Developers can view or obtain documentation source files by visiting the GitHub repository and switching to the Git branch corresponding to the TiDB version. To contribute content, please read the CONTRIBUTING.md guide and submit a Pull Request; to customize PDF documentation, please refer to the self-generation tutorials in the resources directory.