Apache Flink webサイト はApache Flinkとそのコミュニティを紹介します。それは以下のいくつかの目的に役立ちます:
webサイトを改善するどのような貢献も歓迎します。このドキュメントはFlinkのwebサイトを改善するために必要な全ての情報を含みます。
Apache Flinkのwebサイトは、Githubのhttps://github.com/apache/flink-webにミラーされている専用のgitリポジトリにホストされています。
webサイトの更新に貢献する一番簡単な方法は、右上のforkボタンをクリックすることで、Github上のミラーされたwebサイト リポジトリを自身のGithubアカウントにフォークすることです。Githubアカウントを持っていない場合は、無料で作成することができます。
次に、フォークをローカルマシーンにクローンします。
git clone https://github.com/<your-user-name>/flink-web.git
flink-web ディレクトリはクローンされたリポジトリを含みます。webサイトはリポジトリのasf-siteブランチ内にあります。ディレクトリの中に入りasf-site ブランチに切り替えるために、以下のコマンドを実行します。
cd flink-web
git checkout asf-site
FlinkのwebサイトはMarkdownで書かれています。Markdown はHTMLに翻訳することができる軽量マークアップ言語です。Markdownから静的なHTMLファイルを生成するためにJekyll を使います。
webサイト gitリポジトリ内のファイルとディレクトリは以下の役割を持ちます:
.mdで終わる全てのファイルは Markdown ファイルです。これらのファイルは静的なHTMLファイルに翻訳されます。_)で始まらない)も .md ファイルを含みます。ディレクトリ構造は生成されるHTMLファイルと公開されるwebサイトに反映されます。_posts ディレクトリはblog投稿を含みます。各blog投稿は1つのMarkdownファイルとして書かれます。投稿に貢献するには、そこに新しいファイルを追加してください。_includes/ ディレクトリはナビゲーションバーあるいはフッターのようなインクルード可能なファイルを含みます。docs/ディレクトリは異なるリリースのためのFlinkのドキュメントのコピーを含みます。各安定リリースと最新のSNAPSHOTバージョンのためにdocs/の中にディレクトリがあります。ビルドスクリプトがこのディレクトリの維持の面倒を見ています。content/ ディレクトリは Jekyllから生成されたHTMLファイルを含みます。Flink webサイトをホストするApacheのインフラストラクチャはこのディレクトリからHTMLの内容を取ってくるため、このディレクトリ内にファイルを配置することが重要です。(コミッターへ: webサイトのgitへ変更をプッシュする場合は、content/ ディレクトリ内へも更新をプッシュしてください！)MarkdownファイルあるいはCSSファイルのような他のリソースを変更あるいは追加することで、webサイトを更新し拡張することができます。変更を検証するには、プレビューモードのビルドスクリプトを開始してください。
./build.sh -p
スクリプトはMarkdownファイルをHMTLにコンパイルし、ローカルwebサーバを開始します。変更を含むwebサイト見るために、ブラウザで http://localhost:4000を開きます。ファイルを修正し保存してブラウザを更新すると、提供されるwebサイトは自動的に再コンパイルされ更新されます。
どのような質問でも気軽に開発者メーリングリストに聞いてください。
Flink プロジェクトはGitHub Mirror を通じて Pull Requestsとしてのwebサイトの貢献を受け付けます。プルリクエストは、変更を含むコードブランチへのポインタを提供することで、パッチを提供する一番簡単な方法です。
プルリクエストを準備しサブミットするには、以下のステップに従います。
変更をローカルのgitリポジトリにコミットします。(content/ directory内のどのファイルにも)コミットに翻訳されたファイルを含まないようにしてください。 貢献がwebサイトの大規模な再工事では無い場合は、1つのコミットに押し込めてください。
GithubのFlinkリポジトリのあなたのフォークの専用のブランチにコミットをプッシュします。
git push origin myBranch
リポジトリのフォークのwebサイト (https://github.com/<your-user-name>/flink-web) に行き、プルリクエストの作成を開始するために "Create Pull Request" ボタンを使います。基本のフォークは apache/flink-web asf-site で、headフォークがあなたの変更のブランチを選択するようにしてください。プルリクエストに意味のある説明を付け、それをサブミットします。
このセクションはコミッターにのみ関連します。
ASF writable: https://git-wip-us.apache.org/repos/asf/flink-web.git
ASF read-only: git://git.apache.org/repos/asf/flink-web.git
ASFのgitリポジトリのための証明書を設定する方法の詳細はここにリンクされています。
貢献はソースファイル上にのみ行われることが期待されます (content/ ディレクトリ内のコンパイルされたファイルは変更しません)。webサイトの変更をプッシュする前に、ビルドスクリプトを実行してください。
./build.sh
追加のコミットとして変更を content/ ディレクトリに追加し、その変更をASFリポジトリへプッシュします。
ビルドスクリプトは docs/ ディレクトリの維持の面倒も見ます。ドキュメントを更新するには-u フラグを設定してください。これはFlink gitリポジトリの取り込みとドキュメントの異なるバージョンのコピーを含みます。