Kubernetesのドキュメントに貢献する
このウェブサイトはKubernetes SIG Docsが管理しています。 Kubernetesプロジェクトは初心者でも経験者でも、全てのコントリビューターからの改善を歓迎しています！
Kubernetesドキュメントコントリビューターは
- 既存のコンテンツを改善します
- 新しいコンテンツを作成します
- ドキュメントを翻訳します
- Kubernetesリリースサイクルの一部としてドキュメントを管理・公開します
はじめに
どなたでも、問題を説明するissueや、ドキュメントの改善を求めるissueを作成し、kubernetes/website GitHubリポジトリに対するプルリクエスト(PR)を用いて変更に貢献することができます。
Kubernetesコミュニティで効果的に働くためには、gitとGitHubを基本的に使いこなせる必要があります。
ドキュメンテーションに関わるには:
- CNCFのContributor License Agreementにサインしてください。
- ドキュメンテーションのリポジトリと、ウェブサイトの静的サイトジェネレーターに慣れ親しんでください。
- プルリクエストのオープンと変更レビューの基本的なプロセスを理解していることを確認してください。
ドキュメントを管理する]
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は新たなコントリビューターのためのロードマップを概説しています。サインアップやレビューのステップのいくつか、またはその全てに従えばよいです。これで、プルリクエストのオープンの下にリストされているいくつかの貢献目標を達成するためのプルリクエストを開く準備が整いました。また、質問はいつでも歓迎です！
一部のタスクでは、Kubernetes organizationで、より多くの信頼とアクセス権限が必要です。 役割と権限についての詳細は、SIG Docsへの参加を参照してください。
はじめての貢献
あらかじめいくつかのステップを見直すことで、最初の貢献に備えることができます。図2はそれらのステップの概説で、詳細は次のとおりです。
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
- 貢献のための複数の方法について学ぶために貢献の概要を読んでください。
- 良い開始地点を探すために
kubernetes/websiteのissueリストを確認してください。 - 既存のドキュメントに対してGitHubを使ってプルリクエストを作成し、GitHubへのissueの登録について学んでください。
- 正確さと言語の校正のため、他のKubernetesコミュニティメンバーからプルリクエストのレビューを受けてください。
- 見識のあるコメントを残せるようにするため、Kubernetesのコンテンツとスタイルガイドを読んでください。
- ページコンテンツの種類とHugoショートコードについて勉強してください。
貢献時の支援の受け方
はじめて貢献を行うのは大変なことかもしれません。新規コントリビューターのためのアンバサダーは、最初の数回の貢献を行う手助けをしてくれます。Kubernetes Slackで、特に#sig-docsチャンネルを用いて連絡を取ることができます。また毎月第一火曜日に行われる新規コントリビューターのための歓迎会もあります。ここで新規コントリビューターのアンバサダーと交流し、質問に答えてもらうことができます。
訳注: 日本語ローカライゼーションに関しては、Slackのkubernetes-docs-jaチャンネルを利用してください。
次のステップ
- リポジトリのローカルクローンでの作業について学んでください。
- リリース機能について記載してください。
- SIG Docsに参加し、memberやreviewerになってください。
- 国際化を始めたり、支援したりしてください。
SIG Docsに参加する
SIG DocsはKubernetesのドキュメントとウェブサイトを公開・管理するコントリビューターのグループです。SIG Docsに参加することはKubernetesコントリビューター(機能開発でもそれ以外でも)にとってKubernetesプロジェクトに大きな影響を与える素晴らしい方法の一つです。
SIG Docsは複数の方法でコミュニケーションをとっています。
- Kubernetes Slackインスタンスの
#sig-docsに参加してください。自己紹介を忘れずに！- 訳注: 日本語ローカライゼーションに関しては、Slackの
kubernetes-docs-jaチャンネルを利用してください。
- 訳注: 日本語ローカライゼーションに関しては、Slackの
kubernetes-sig-docsメーリングリストに参加してください。ここでは幅広い議論が起こり、公式な決定が記録されます。- 毎週のSIG Docsビデオミーティングに参加してください。ミーティングは
#sig-docsでアナウンスされ、Kubernetesコミュニティミーティングカレンダーに追加されます。Zoomクライアントをダウンロードするか、電話を使って通話する必要があります。
その他の貢献方法
- Kubernetesコミュニティサイトを訪問してください。TwitterやStack Overflowに参加したり、Kubernetesの集会やイベントについて学んだりしてください。
- 機能開発に貢献したい方は、まずはじめにKubernetesコントリビューターチートシートを読んでください。
- Kubernetesのコントリビューターや追加のコントリビューター向けリソースについてもっと学ぶために、コントリビューターサイトを読んでください。
- ブログ記事やケーススタディを投稿してください。