このプロジェクトについて
このリポジトリには、Apache Doris 公式ウェブサイト(doris.apache.org)のソースコードが含まれています。Docusaurus 3 を使用したモダンな静的サイトジェネレーターで構築されています。
含まれるもの
- ドキュメント:英語と中国語(zh-CN)の複数バージョン(current/dev、4.x、3.x、2.1)のドキュメント
- ブログ:プロジェクトのニュースと発表
- コミュニティ:貢献ガイドとコミュニティリソース
- React コンポーネント:src/ ディレクトリ内のカスタムページと UI 要素
技術スタック
- Docusaurus 3(静的サイトジェネレーター)
- Node.js >= 18
- Yarn パッケージマネージャー
- React ベースのコンポーネント
ローカル開発
ヘルパースクリプト(local_dev.sh)により、サイトをローカルで簡単に実行できます。
- 英語開発サーバーを起動:./local_dev.sh
- 中国語開発サーバーを起動:./local_dev.sh start-zh
- カスタムポートで起動:./local_dev.sh start --port 8080
- 本番ビルド(英語+中国語):./local_dev.sh build-all
メモリを増やすには、NODE_OPTIONS=--max-old-space-size=8192 を設定して大規模ビルドを行います。
バージョニング
ドキュメントは、docs/(現在)と versioned_docs/(アーカイブバージョン)の下にリリースラインごとの別ディレクトリで管理されます。サイドバーはそれぞれバージョンごとに sidebars.ts と versioned_sidebars/ で管理されます。
多言語サポート
サイトは英語と簡体字中国語をサポートします。中国語訳は i18n/zh-CN/ に配置されます。編集時は通常、両言語バージョンを更新する必要があります。
ディレクトリ構造
- docs/ — 現在の英語ドキュメント
- versioned_docs/ — バージョンごとにアーカイブされた英語ドキュメント
- i18n/zh-CN/ — 上記構造に対応する中国語訳
- blog/ — Markdown ブログ投稿
- community/ — コミュニティドキュメント
- src/ — React コンポーネントとカスタムページ
- static/ — 静的アセット(画像、CSS、JS)
CI / デプロイ
GitHub Actions が自動ビルドを処理します。
- Doris master ブランチからの毎日の cron デプロイ同期
- 特定ブランチ向けの手動デプロイワークフロー
- プルリクエストでのビルド検証
貢献
貢献ガイドは Doris ウェブサイトにあり、ドキュメントのフォーマット仕様と一般的な貢献プロセスが説明されています。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.