ホームトレンドpingcap/docs-cn
// archived 2026-04-17
pingcap

docs-cn

Database#TiDB#Documentation#Distributed Database#SQL
GitHub で見る →
1,835

// 概要

本リポジトリは PingCAP 公式サイトにおける TiDB 中国語ドキュメントのソースファイルを管理しており、開発版から各リリース版までの詳細な技術資料を網羅しています。ユーザーは Issue や Pull Requests を提出することで、ドキュメントの保守や改善に貢献できます。さらに、特定の利用要件を満たすために、カスタマイズされた PDF ドキュメントを自己生成するためのチュートリアルも提供しています。

// 技術解説

TiDB documentation リポジトリは PingCAP の公式中国語ドキュメントのソースファイルリポジトリであり、Git ブランチに基づくバージョン管理アーキテクチャを利用して、ドキュメントが TiDB データベースの各リリースバージョンと厳密に対応するようにしています。このプロジェクトは、オープンソースのコラボレーションモデルを通じて複雑な分散データベースのドキュメントを維持・更新するという課題に対処しており、コミュニティメンバーが Issues や Pull Requests を通じてドキュメントの最適化に直接参加できるようになっています。そのコアとなる設計上のトレードオフは、ブランチを通じて異なるライフサイクルのドキュメントバージョンを分離することにあり、これによりアクティブな開発バージョンのメンテナンスをサポートしつつ、アーカイブされた古いバージョンに対して安定した参照基盤を提供しています。

// 主要ハイライト

01
マルチバージョンブランチ管理を提供し、ドキュメントが TiDB の各開発マイルストーンや長期サポートバージョンと正確に一致することを保証します。
02
コミュニティ主導の貢献モデルをサポートしており、ユーザーは Pull Requests を送信することでドキュメントコンテンツの改善に直接参加できます。
03
PDF を自己生成するためのチュートリアルを提供しており、ユーザーが特定のニーズに合わせてドキュメントコンテンツをカスタマイズおよびフィルタリングするのに便利です。
04
明確なアーカイブメカニズムを備えており、更新が停止したドキュメントバージョンを明示することで、ユーザーが古い情報を取得するリスクを低減します。
05
CC BY-SA 3.0 ライセンスを採用しており、ドキュメントコンテンツのオープンソースとしての利用および配布権を標準化しています。

// ユースケース

01
TiDB の各バージョンに関する技術ドキュメントの参照
02
Pull Requests を通じたドキュメントコンテンツへの貢献
03
PDF 形式でのドキュメントの自己カスタマイズおよび生成

// クイックスタート

開発者は GitHub リポジトリにアクセスし、対応する TiDB バージョンの Git ブランチに切り替えることで、ドキュメントのソースファイルを閲覧または取得できます。コンテンツに貢献するには CONTRIBUTING.md ガイドを読み、Pull Request を送信してください。PDF ドキュメントをカスタマイズするには、resources ディレクトリ内の自己生成チュートリアルを参照してください。