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

Kubernetesは初心者でも経験者でも、全てのコントリビューターからの改善を歓迎しています！

このウェブサイトはKubernetes SIG Docsが管理しています。

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

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

はじめに

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

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

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

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

はじめての貢献

• 貢献のための複数の方法について学ぶために貢献の概要を読んでください。
• 良い開始地点を探すためにkubernetes/website issueリストを確認してください。
• 既存のドキュメントに対してGitHubを使ってプルリクエストをオープンし、GitHubへのissueの登録について学んでください。
• 正確さと言語の校正のため、他のKubernetesコミュニティメンバーからプルリクエストのレビューを受けてください。
• 見識のあるコメントを残せるようにするため、Kubernetesのコンテンツとスタイルガイドを読んでください。
• ページコンテンツの種類とHugoショートコードについて勉強してください。

次のステップ

• リポジトリのローカルクローンでの作業について学んでください。
• リリース機能について記載してください。
• SIG Docsに参加し、memberやreviewerになってください。
• 国際化を始めたり、支援したりしてください。

SIG Docsに参加する

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

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

• Kubernetes Slackインスタンスの#sig-docsに参加してください。自己紹介を忘れずに！
• kubernetes-sig-docsメーリングリストに参加してください。ここでは幅広い議論が起こり、公式な決定が記録されます。
• 毎週のSIG Docsビデオミーティングに参加してください。ミーティングは #sig-docsでアナウンスされ、Kubernetesコミュニティミーティングカレンダーに追加されます。Zoomクライアントをダウンロードするか、電話を使って通話する必要があります。

その他の貢献方法

• Kubernetesコミュニティサイトを訪問してください。TwitterやStack Overflowに参加したり、Kubernetesの集会やイベントについて学んだりしてください。
• 機能開発に貢献したい方は、まずはじめにKubernetesコントリビューターチートシートを読んでください。
• ブログ記事やケーススタディを投稿してください。