615
// 概要
本リポジトリは TiDB の公式ドキュメントファイルを一元管理する中心的な場所です。複数のバージョンや言語を包括的にサポートし、ユーザーがデータベースプラットフォームを円滑に利用できるよう支援します。ドキュメントの品質向上のため、Issue や pull request を通じたプロジェクトへの貢献を歓迎します。
// 技術解説
TiDB documentation リポジトリは、すべての公式技術ドキュメントの集約拠点であり、特定の TiDB リリースとの整合性を維持するためにブランチベースのバージョン管理戦略を採用しています。ドキュメントをコアコードベースから分離することで、透明性の高い pull request ワークフローを通じたコミュニティ主導の改善を可能にしています。このアーキテクチャにより、ユーザーは現在の開発ドキュメントとアーカイブされた過去のバージョンの両方にアクセスでき、複雑なマルチバージョンソフトウェアのライフサイクル情報を管理するという課題に効果的に対処しています。
// 主要ハイライト
01
LTS や開発マイルストーンリリースを含む、複数の TiDB バージョンにわたる包括的なドキュメントを維持しています。
02
コミュニティ主導の貢献をサポートしており、ユーザーは Issue や pull request を送信してドキュメントの品質を向上させることができます。
03
特定のユーザー要件に合わせてカスタム PDF バージョンのドキュメントを生成するための専用チュートリアルを提供しています。
04
公式の英語および中国語版を提供し、追加言語への自動翻訳をサポートすることで、グローバルなアクセシビリティを促進しています。
05
明確なブランチベースのバージョン管理システムを利用して、アクティブな開発ドキュメントとアーカイブされたレガシードキュメントを区別しています。
// ユースケース
01
TiDB の各バージョンに対応した公式ドキュメントへのアクセス
02
pull request を通じたドキュメント更新への貢献
03
TiDB ドキュメントのカスタマイズされた PDF バージョンの生成
// クイックスタート
このプロジェクトを開始するには、リポジトリのブランチに移動し、使用している TiDB デプロイメントに対応するドキュメントバージョンを選択してください。ソースファイルを GitHub 上で直接閲覧するか、公式の PingCAP ドキュメント Web サイトにアクセスしてレンダリングされたビューを確認できます。貢献を希望する場合やカスタム PDF 出力を生成したい場合は、CONTRIBUTING.md ファイル、または resources フォルダにある PDF 生成チュートリアルを参照してください。