Kubernetesの基本を学ぶ

Kubernetesのドキュメントに貢献する

Edit This Page

Kubernetesのドキュメントに貢献する

ドキュメントやウェブサイトに貢献したい方、ご協力お待ちしています。 はじめての方、久しぶりの方、開発者でもエンドユーザでも、はたまたタイポを見逃せない方でもどなたでも貢献可能です。

ドキュメントのスタイルガイドについてはこちら。

コントリビューターの種類

  • メンバー は、すでに CLA に署名しており、本プロジェクトに何度も貢献している方です。 Community membershipを読んで、会員規約をご確認ください。
  • レビュアー は、ドキュメントのPRレビューへ関心を示しており、承認者によりすでにGitHubグループ、およびGitHubレポジトリーのOWNERSファイルに追加されているメンバーです。
  • 承認者 は、本プロジェクトに継続してコミットできているメンバーです。Kubernetes organizationを代表して、PRをマージしたり、コンテンツを公開することができます。 また、Kubernetes コミュニティにおいて、SIG Docsを代表することもできますが、リリースの調整などのように、相応の時間をコミットすることも求められます。

ドキュメントへの貢献方法

以下に挙げたものは、どなたでも可能なこと、Kubernetes organizationメンバーであれば可能なこと、SIG Docsのプロセスにアクセスでき、かつ慣れていないとできないことにわかれています。 継続的に貢献していけば、ノウハウや組織的決断を理解する手助けとなるでしょう。

これがKubernetesドキュメントへ貢献する方法の全てではないですが、手始めには良いでしょう。

  • どなたでも
    • issue を作成する
  • メンバー
    • 既存のドキュメントを改善する
    • 改善のアイデアをSlackもしくはSIG docs mailing listに投げる
    • ドキュメントのアクセシビリティを改善する
    • PRにフィードバックをする
    • 事例やブロクを書く
  • レビュアー
    • 新機能のドキュメントを作成する
    • issueの選別、分類をする
    • PRをレビューする
    • 図表や、グラフィック資産、埋め込み可能な動画などを作成する
    • 多言語対応
    • ドキュメントの代表者として別のレポジトリに貢献する
    • コード内にある、ユーザが使う文字列を編集する
    • コードのコメントやGodocを改善する
  • 承認者
    • PRを承認、マージすることでコントリビューターが作成したコンテンツを公開する
    • Kubernetesのリリースチームに、ドキュメントを代表して参加する
    • スタイルガイドの改善を提案する
    • ドキュメントテストの改善を提案する
    • Kubernetesのウェブサイトやその他ツールの改善を提案する

その他の貢献方法

フィードバック