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

Edit This Page

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

あなたがKubernetesのドキュメンテーションやWebサイトに貢献するのを手伝いたいのであれば、私たちはあなたの貢献を嬉しく思います!プロジェクトに関わって日が浅いのか、それとも長きに渡って関わっているのか、開発者、エンドユーザ、または誤植に耐えられない人かどうかに関係なく、誰でも貢献できます。

Kubernetesコミュニティに参加する、または私たちについて学ぶためのより多くの方法については、Kubernetesコミュニティサイトをご覧ください。Kubernetesドキュメントのスタイルガイドについては、スタイルガイドを参照してください。

寄稿者のタイプ

  • CLAに署名し、プロジェクトにいくらかの時間と努力を費やしたKubernetes組織の*メンバー*。メンバーシップの具体的な基準については、コミュニティメンバーシップを参照してください。
  • SIG Docs*レビューワー*は、ドキュメントのプルリクエストのレビューに関心を示し、SIG Docs承認者によってGithubリポジトリの適切なGithubグループとOWNERSファイルに追加されたKubernetes組織のメンバーです。
  • SIG Docs*承認者*は、プロジェクトに対する継続的なコミットメントを示している優秀なメンバーです。承認者はKubernetes組織に代わってプルリクエストをマージし、コンテンツを公開できます。承認者は、より大きなKubernetesコミュニティのSIG Docsを代表することもできます。リリースの調整など、SIG Docs承認者の任務の中には、かなりの時間を要するものがあります。

貢献する方法

このリストは、誰でもできること、Kubernetes組織のメンバーができること、そしてより高いレベルのアクセスとSIG Docsプロセスへの精通を必要とすることに分けられます。時間をかけて一貫して貢献することで、すでに行われた作業や組織上の決定について理解するのに役立ちます。

これはKubernetesのドキュメントに貢献できる方法の網羅的なリストではありませんが、始めるのに役立ちます。

  • 全ての人
    • 対処可能なバグのファイル
  • メンバー
    • 既存のドキュメントの改善
    • SlackまたはSIG docsメーリングリストで改善のためのアイデアを発案
    • ドキュメントのアクセシビリティの向上
    • PRに拘束力のないフィードバックの提供
    • ブログ記事やケーススタディの執筆・投稿
  • レビューワー
    • 新機能のドキュメンテーション
    • 問題のトリアージと分類
    • PRの確認
    • ダイアグラム、グラフィックアセット、および埋め込み可能なスクリーンキャスト/ビデオの作成
    • ローカライゼーション
    • ドキュメントの代表として他のリポジトリに貢献する
    • コード内のユーザー向け文字列を編集する
    • Godoc、コードのコメントを改善する
  • 承認者
    • PRを承認およびマージして寄稿者コンテンツを公開
    • ドキュメント代表としてKubernetesリリースチームに参加する
    • スタイルガイドに改善を提案する
    • docsテストの改善を提案する
    • KubernetesのWebサイトまたはその他のツールの改良を提案する

貢献するその他の方法

フィードバック