GitHub の利用

約3分

Istio ドキュメントは、プルリクエスト（PR）について標準的な GitHub コラボレーションフローに従っています。この確立されたコラボレーションモデルは、オープンソースプロジェクトが以下の種類の貢献を管理するのに役立ちます。

リポジトリに新しいファイルを追加する。追加
既存のファイルを編集する。編集
追加または変更されたファイルを確認する。レビュー
複数のリリースまたは開発ブランチを管理する。

貢献ガイドでは、次のタスクを完了できることを前提としています。

Istio ドキュメントリポジトリをフォークする。
変更のためのブランチを作成する。
そのブランチにコミットを追加する。
PR を開き、貢献を共有する。

始める前に

Istio ドキュメントに貢献するには、次の必要があります。

GitHubアカウントを作成する。
コントリビューターライセンス契約に署名する。
変更をプレビューしてテストするために、作成システムに Docker をインストールする。

Istio ドキュメントは、Apache 2.0 ライセンスの下で公開されています。

簡単な編集の実行

CLA に署名した GitHub アカウントを持つユーザーであれば誰でも、Istio ウェブサイトの任意のページに簡単な編集を貢献できます。手順は非常に簡単です。

編集したいページにアクセスします。
URLの先頭にpreliminaryを追加してください。例えば、https://istio.dokyumento.jp/aboutを編集する場合は、新しいURLはhttps://preliminary.istio.io/aboutになります。
右下隅の鉛筆アイコンをクリックしてください。
GitHub UIで編集を行ってください。
変更を伴うプルリクエストを送信してください。

より大規模な変更の送信方法の詳細については、新しいコンテンツの追加方法またはコンテンツのレビュー方法に関するガイドをご覧ください。

ブランチ戦略

アクティブなコンテンツ開発は、istio/istio.ioリポジトリのmasterブランチを使用して行われます。Istioのリリース日には、そのリリースに対応するmasterブランチからリリースブランチを作成します。次のボタンをクリックすると、GitHubのリポジトリに移動します。

このサイトのソースコードを参照する

Istioドキュメントリポジトリは、すべてのIstioリリースのドキュメントを公開するために複数のブランチを使用しています。各Istioリリースには、対応するドキュメントブランチがあります。例えば、release-1.0、release-1.1、release-1.2といったブランチがあります。これらのブランチは、対応するリリース日に作成されました。特定のリリースのドキュメントを参照するには、アーカイブページをご覧ください。

このブランチ戦略により、次のIstioオンラインリソースを提供できます。

公開サイトには、現在のリリースブランチのコンテンツが表示されます。
https://preliminary.istio.ioにあるプレリミナリーサイトには、masterブランチのコンテンツが表示されます。
アーカイブサイトには、以前のすべてのリリースブランチのコンテンツが表示されます。

ブランチの仕組みから、masterブランチに変更を送信した場合、その変更は次のメジャーなIstioリリースが行われるまでistio.ioには表示されません。ドキュメントの変更が現在のIstioリリースに関連する場合は、現在のリリースブランチにも変更を適用する価値があるでしょう。ドキュメントPRの特別なcherry-pickラベルを使用することで、簡単かつ自動的にこれを行うことができます。例えば、masterブランチのPRで修正を導入した場合、cherrypick/release-1.4ラベルを適用して、この変更をrelease-1.4ブランチにマージすることができます。

最初のPRがマージされると、自動化によって、変更を含む新しいPRがリリースブランチに作成されます。

まれに、自動的なcherry-pickが機能しない場合があります。その場合、自動化は、失敗したことを示すメモを元のPRに残します。その場合は、手動でcherry-pickを作成し、プロセスが自動的に機能しなかった原因となったマージの問題に対処する必要があります。

現在のリリースブランチには変更をcherry-pickしますが、古いブランチには決してcherry-pickしないことに注意してください。古いブランチはアーカイブ済みと見なされ、一般的に変更を受け付けなくなります。