この記事では、エラーの修正、ガイダンスの改善、Azureでの Linux Azure実行に役立つ新しいコンテンツの追加によって、Azure Linux ドキュメントに貢献する方法について説明し、サポートされている Azure Linux シナリオのガイダンスを提供します。
Note
Azure Linux 4.0 は現在、preview であり、評価とテストの目的に厳密に限定されています。 運用環境での使用には適していません。
対象範囲のドキュメントへの貢献
Azure Linux のドキュメントでは、Azure シナリオのみについて説明しています。これは、Microsoftのサポートとライフサイクルのコミットメントに沿っています。 Microsoft は、Azureで Azure Linux を使用するのに役立つコンテンツの投稿を維持し、受け入れます。具体的には次のとおりです。
- Azure Linux Virtual Machines (VM) /Virtual Machine Scale Sets (VMSS)、AKS、コンテナー イメージのガイダンス。
- 事前構築済みのAzure Linux イメージの上に構築されたカスタマイズ (たとえば、Image Customizer)。
ギャップ、エラー、またはAzureに重点を置いたガイダンスを改善する機会が見られた場合は、Microsoft と共有してください。
対象外のドキュメントへの貢献
ドキュメントに重点を置き、保守可能な状態を維持するために、次の種類の投稿が閉じられます。
- ベア メタル、ISO イメージ、オンプレミス、その他のクラウド、または GitHub 上の Azure Linux ソース から一から構築されたイメージなど、Microsoft のサポートおよびライフサイクル コミットメントの対象外のシナリオ向けのコンテンツ
- 新しい値を追加せずに、別のページに既に存在するものを修正するコンテンツを複製します。
Azure Linux エコシステム外の特定の製品<、ツール、またはサービスを強調表示する、プロモーションまたはベンダー固有のコンテンツ>。 - サポートされている Azure Linux 構成でテストされていない特別なガイダンスまたは未確認のガイダンス。
- 事前の問題報告やメンテナンス担当者の承認なしに提出された、大規模な無断の改変。
スタイルと書式設定のガイドライン
Azure Linux のドキュメントは、Microsoft Learn ドキュメント スタイル ガイドに従います。 すべての貢献は、これらの標準と一致する必要があります。 これらの規則に従っていないプル要求 (PR) は、レビューが開始される前にリビジョン用に返送される可能性があります。
ドキュメントの変更を送信する
Important
すべてのドキュメントへの貢献には、まず Issue の作成が必要です。 関連する問題なしで PR を開かないでください。 リンクされた問題のない PR は、レビューなしで閉じられる可能性があります。
ドキュメントの変更を送信する手順:
- 課題を作成します。 改善のギャップ、エラー、または機会について説明します。 できるだけわかりやすいものにする。には、Azure サービス、Azure Linux バージョン、ワークロードの種類、および関連するコンテキストまたは再現の手順が含まれます。 作業を開始する前に、メンテナーが問題を確認するのを待ちます。
- 重複を検索します。 提出する前に、既存の問題と PR を確認して、作業の重複を避けてください。
-
フォークと分岐。 メンテナーが問題を確認したら、リポジトリの個人用フォークと、わかりやすい名前のブランチ (
fix/aks-quickstart-typoやdocs/selinux-recipeなど) を作成します。 - PR を送信します。 承認された問題を PR の説明にリンクします。 変更を簡潔でタスク指向に保ちます。 レビュー担当者が投稿を評価できるように、Azure サービス、Azure Linux バージョン、ワークロードの種類などのコンテキストを含めます。
- レビューを待ちます。 保守担当者が PR を確認します。 要求された場合は、変更を加える準備をしてください。 すべての PR がマージされるとは限りません。
PR を送信した後に予想される内容
- レビューは可能な範囲で行われます。 保守担当者は、容量が許す限り貢献度を確認します。 応答時間は異なる場合があり、コミュニティ PR に対する保証されたサービス レベル アグリーメント (SLA) はありません。
- すべてのコントリビューションがマージされるわけではありません。 PR は、Azureサポートされているスコープ外にある場合、既存のコンテンツを複製する場合、またはドキュメントの方向に合わない場合に閉じられる可能性があります。
- 修正を求められる場合があります。 レビュー担当者は、PR を承認する前に、スコープ、精度、または書式設定の変更を要求する場合があります。
- 問題は、アクションなしで閉じられる可能性があります。 問題が不完全な場合、スコープ外である場合、または 30 日後にアクティビティがない場合は、クローズされる可能性があります。
- 古い PR は閉じられます。 アクティビティが 30 日間ない PR は、自動的に閉じられる場合があります。 PR の作業を続行する場合は、再度開くことができます。
関連するコンテンツ
Azure Linux への貢献の詳細については、「Azure Linux に貢献する方法を参照してください。