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

このウェブサイトはKubernetes SIG Docsが管理しています。 Kubernetesプロジェクトは初心者でも経験者でも、全てのコントリビューターからの改善を歓迎しています!

Kubernetesドキュメントコントリビューターは

  • 既存のコンテンツを改善します
  • 新しいコンテンツを作成します
  • ドキュメントを翻訳します
  • Kubernetesリリースサイクルの一部としてドキュメントを管理・公開します

はじめに

どなたでも、問題を説明するissueや、ドキュメントの改善を求めるissueを作成し、kubernetes/website GitHubリポジトリに対するプルリクエスト(PR)を用いて変更に貢献することができます。 Kubernetesコミュニティで効果的に働くためには、gitGitHubを基本的に使いこなせる必要があります。

ドキュメンテーションに関わるには:

  1. CNCFのContributor License Agreementにサインしてください。
  2. ドキュメンテーションのリポジトリと、ウェブサイトの静的サイトジェネレーターに慣れ親しんでください。
  3. プルリクエストのオープン変更レビューの基本的なプロセスを理解していることを確認してください。

flowchart TB subgraph third[プルリクエストのオープン] direction TB U[ ] -.- Q[コンテンツを改善する] --- N[コンテンツを作成する] N --- O[ドキュメントを翻訳する] O --- P[k8sリリースサイクルの
ドキュメントを管理する] end subgraph second[レビュー] direction TB T[ ] -.- D[kubernetes/website
リポジトリを確認する] --- E[静的サイトジェネレーター
Hugoを確認する] E --- F[基本的なGitHubの
コマンドを理解する] F --- G[オープンした
プルリクエストを確認し
レビュープロセスを見直す] end subgraph first[サインアップ] direction TB S[ ] -.- B[CNCFの
コントリビューターライセンス
サインに署名する] --- C[Slackチャンネル
sig-docs に
参加する] C --- V[kubernetes-sig-docsの
メーリングリストに
参加する] V --- M[毎週開催している
sig-docs callsや
slack callsに
参加する] end A([fa:fa-user 新たな
コントリビューター]) --> first A --> second A --> third A --> H[質問をする!!!] classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey class S,T,U spacewhite class first,second,third white
図1. 新たなコントリビューターのためのスタートガイド。

図1は新たなコントリビューターのためのロードマップを概説しています。サインアップレビューのステップのいくつか、またはその全てに従えばよいです。これで、プルリクエストのオープンの下にリストされているいくつかの貢献目標を達成するためのプルリクエストを開く準備が整いました。また、質問はいつでも歓迎です!

一部のタスクでは、Kubernetes organizationで、より多くの信頼とアクセス権限が必要です。 役割と権限についての詳細は、SIG Docsへの参加を参照してください。

はじめての貢献

あらかじめいくつかのステップを見直すことで、最初の貢献に備えることができます。図2はそれらのステップの概説で、詳細は次のとおりです。

flowchart LR subgraph second[はじめての貢献] direction TB S[ ] -.- G[K8sメンバーからの
PRレビューを受ける] --> A[最初のPRを作成するための
良いissueを
kubernetes/websiteから探す] --> B[PRをオープンする!!] end subgraph first[推奨される準備] direction TB T[ ] -.- D[コントリビューターの概要を読む] -->E[K8sのコンテンツと
スタイルガイドを読む] E --> F[Hugoのページコンテンツタイプと
ショートコードについて学ぶ] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white
図2. はじめての貢献のための準備。

貢献時の支援の受け方

はじめて貢献を行うのは大変なことかもしれません。新規コントリビューターのためのアンバサダーは、最初の数回の貢献を行う手助けをしてくれます。Kubernetes Slackで、特に#sig-docsチャンネルを用いて連絡を取ることができます。また毎月第一火曜日に行われる新規コントリビューターのための歓迎会もあります。ここで新規コントリビューターのアンバサダーと交流し、質問に答えてもらうことができます。

訳注: 日本語ローカライゼーションに関しては、Slackのkubernetes-docs-jaチャンネルを利用してください。

次のステップ

SIG Docsに参加する

SIG DocsはKubernetesのドキュメントとウェブサイトを公開・管理するコントリビューターのグループです。SIG Docsに参加することはKubernetesコントリビューター(機能開発でもそれ以外でも)にとってKubernetesプロジェクトに大きな影響を与える素晴らしい方法の一つです。

SIG Docsは複数の方法でコミュニケーションをとっています。

その他の貢献方法