ドキュメントレビュープロセス
Istio Docsワーキンググループ（WG）のメンテナーとワーキンググループリーダーが、Istioウェブサイトに対するすべての変更を承認します。
ドキュメントレビュー担当者は、レビュー基準で説明されている受け入れ基準を満たすコンテンツを承認する信頼できるコントリビューターです。すべてのコンテンツレビューは、コンテンツPRのレビューで説明されているプロセスに従います。
DocsメンテナーとWGリーダーのみが、istio.ioリポジトリにコンテンツをマージできます。
Istioのコンテンツは、多くの場合、急なレビューが必要であり、すべてのコンテンツが同じ関連性を持っているわけではありません。貢献のギリギリの性質とレビュアーの有限数により、コンテンツレビューの優先順位付けが、大規模に機能するために必要になります。このページでは、すべてのレビュー作業が一貫して、信頼性高く、同じ品質基準に従って行われるように、明確なレビュー基準を提供します。
コンテンツPRのレビュー
ドキュメントレビュー担当者、メンテナー、WGリーダーは、すべてのレビューが一貫していることを保証するために、コンテンツPRをレビューする明確なプロセスに従います。プロセスは次のとおりです。
- コントリビューターが新しいコンテンツPRをistio.ioリポジトリに提出します。
- レビュー担当者がコンテンツのレビューを実行し、受け入れ基準を満たしているかどうかを判断します。
- レビュー担当者は、コントリビューターがまだ行っていない場合、コンテンツに関連する技術的なWGを追加します。
- コントリビューターとレビュー担当者は、コンテンツが必要なすべての承認基準を満たし、問題が解決されるまで協力します。
- コンテンツが緊急であり、追加の承認基準を満たすために多大な労力が必要な場合、レビュー担当者は、後日問題を解決するために istio.io リポジトリにフォローアップIssueを提出します。
- コントリビューターは、レビュー担当者とコントリビューターが合意したすべての必須および追加のフィードバックに対応します。フォローアップIssueに提出されたフィードバックは後で対応します。
- 技術WGのリーダーまたはメンテナーがコンテンツPRを承認した場合、レビュー担当者はPRを承認できます。
- ドキュメントWGのメンテナーまたはリーダーがコンテンツをレビューした場合、彼らは承認するだけでなく、コンテンツをマージもします。それ以外の場合、メンテナーとリーダーにはレビュー担当者の承認が自動的に通知され、すでにレビュー済みのコンテンツの承認とマージを優先します。
次の図は、プロセスを示しています。
- コントリビューターは、灰色の図形内の手順を実行します。
- レビュー担当者は、青色の図形内の手順を実行します。
- ドキュメントメンテナーおよびWGリーダーは、緑色の図形内の手順を実行します。
課題のフォローアップ
レビュー担当者がレビュープロセスの一環としてフォローアップIssueを提出する場合、GitHub Issueには以下の情報を含める必要があります。
- コンテンツが満たせなかった追加の承認基準に関する詳細。
- 元のPRへのリンク。
- 技術分野の専門家 (SME) のユーザー名。
- Issueを分類するためのラベル。
- 作業の見積もり：レビュー担当者は、元のコントリビューターと協力して残りの問題に対処するのにかかる時間について、可能な限り正確な見積もりを提供します。
レビュー基準
私たちのレビュープロセスは、レビュー基準を透明にし、すべてのコンテンツの投稿に適用することにより、行動規範をサポートしています。
基準には、必須と追加の2つの段階があります。
必須の受け入れ基準
- 技術的な正確性：少なくとも1人の技術WGリーダーまたはメンテナーがコンテンツをレビューし、承認します。
- 正しいマークアップ：すべてのリンティングとテストに合格します。
- 言語：コンテンツは明確で理解しやすい必要があります。詳細については、Google開発者スタイルガイドのハイライトおよび一般的な原則を参照してください。
- リンクとナビゲーション：コンテンツにはリンク切れがなく、サイトが正しくビルドされます。
補足的な受け入れ基準
- コンテンツ構造：情報構造は読者のエクスペリエンスを向上させます。
- 一貫性：コンテンツは、Istio貢献ガイドのすべての推奨事項に従います。
- スタイル：コンテンツは、Google開発者スタイルガイドに従います。
- グラフィックアセット：図は、Istioの図作成ガイドに従います。
- コードサンプル：コンテンツは、関連性があり、テスト可能で、機能するコードサンプルを提供します。
- コンテンツの再利用：繰り返されるコンテンツは、ボイラープレートテキストを使用して再利用戦略に従います。
- 用語集：新しい用語は明確な定義とともに用語集に追加されます。