From bc7567f4a4060b67567fd3e3df6d2eda5627867f Mon Sep 17 00:00:00 2001 From: akitok Date: Sun, 7 Jun 2020 00:41:38 +0900 Subject: [PATCH] Make docs/contribute/_index.md follow v1.17 of the original text --- content/ja/docs/contribute/_index.md | 63 +++++++++++++--------------- 1 file changed, 29 insertions(+), 34 deletions(-) diff --git a/content/ja/docs/contribute/_index.md b/content/ja/docs/contribute/_index.md index 2f6f64fac2..21f5dcf43d 100644 --- a/content/ja/docs/contribute/_index.md +++ b/content/ja/docs/contribute/_index.md @@ -11,49 +11,35 @@ weight: 80 ドキュメントやウェブサイトに貢献したい方、ご協力お待ちしています。 はじめての方、久しぶりの方、開発者でもエンドユーザでも、はたまたタイポを見逃せない方でもどなたでも貢献可能です。 -ドキュメントのスタイルガイドについては[こちら](/docs/contribute/style/style-guide/)。 +{{% /capture %}} {{% capture body %}} -## コントリビューターの種類 +## はじめに -- _メンバー_ は、すでに [CLA に署名](/docs/contribute/start#sign-the-cla)しており、本プロジェクトに何度も貢献している方です。 - [Community membership](https://github.com/kubernetes/community/blob/master/community-membership.md)を読んで、会員規約をご確認ください。 -- _レビュアー_ は、ドキュメントのPRレビューへ関心を示しており、承認者によりすでにGitHubグループ、およびGitHubレポジトリーの`OWNERS`ファイルに追加されているメンバーです。 -- _承認者_ は、本プロジェクトに継続してコミットできているメンバーです。Kubernetes organizationを代表して、PRをマージしたり、コンテンツを公開することができます。 - また、Kubernetes コミュニティにおいて、SIG Docsを代表することもできますが、リリースの調整などのように、相応の時間をコミットすることも求められます。 +どなたでも、問題を説明するissueや、ドキュメントの改善を求めるissueを作成し、プルリクエスト(PR)を用いて変更に貢献することができます。 +一部のタスクでは、Kubernetes organizationで、より多くの信頼とアクセスが必要です。 +役割と権限についての詳細は、[SIGドキュメントへの参加](/docs/contribute/participating/)を参照してください。 -## ドキュメントへの貢献方法 +Kubernetesのドキュメントは、GitHubのリポジトリにあります。 +どなたからの貢献も歓迎しますが、Kubernetesコミュニティの効果的な運用のためには、gitとGitHubを基本的に使いこなせる必要があります。 -以下に挙げたものは、どなたでも可能なこと、Kubernetes organizationメンバーであれば可能なこと、SIG Docsのプロセスにアクセスでき、かつ慣れていないとできないことにわかれています。 -継続的に貢献していけば、ノウハウや組織的決断を理解する手助けとなるでしょう。 +ドキュメンテーションに関わるには: -これがKubernetesドキュメントへ貢献する方法の全てではないですが、手始めには良いでしょう。 +1. CNCFの[Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md)にサインしてください。 +2. [documentation repository](https://github.com/kubernetes/website)と、ウェブサイトの[static site generator](https://gohugo.io)に慣れ親しんでください。 +3. [コンテンツの改善](https://kubernetes.io/docs/contribute/start/#improve-existing-content)と[変更レビュー](https://kubernetes.io/docs/contribute/start/#review-docs-pull-requests)の基本的なプロセスを理解していることを確認してください。 -- [どなたでも](/docs/contribute/start/) - - issue を作成する -- [メンバー](/docs/contribute/start/) - - 既存のドキュメントを改善する - - 改善のアイデアを[Slack](http://slack.k8s.io/)もしくは[SIG docs mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)に投げる - - ドキュメントのアクセシビリティを改善する - - PRにフィードバックをする - - 事例やブロクを書く -- [レビュアー](/docs/contribute/intermediate/) - - 新機能のドキュメントを作成する - - issueの選別、分類をする - - PRをレビューする - - 図表や、グラフィック資産、埋め込み可能な動画などを作成する - - 多言語対応 - - ドキュメントの代表者として別のレポジトリに貢献する - - コード内にある、ユーザが使う文字列を編集する - - コードのコメントやGodocを改善する -- [承認者](/docs/contribute/advanced/) - - PRを承認、マージすることでコントリビューターが作成したコンテンツを公開する - - Kubernetesのリリースチームに、ドキュメントを代表して参加する - - スタイルガイドの改善を提案する - - ドキュメントテストの改善を提案する - - Kubernetesのウェブサイトやその他ツールの改善を提案する +## 貢献するためのベストプラクティス +- 明快で意味のあるGitコミットメッセージを書いてください。 +- PRがマージされたときにissueを参照し、自動的にissueをクローズする_Github Special Keywords_を必ず含めるようにしてください。 +- タイプミスの修正や、スタイルの変更、文法の変更などのような小さな変更をPRに加える場合は、必ず _Github Special Keywords_ を含めるようにしてください。比較的小さな変更のために多くのコミットを得ることがないように、コミットはまとめてください。 +- あなたがコードを変更をした理由を示し、レビュアーがあなたのPRを理解するのに十分な情報を確保した適切なPR説明を、必ず含めるようにしてください。 +- 追加文献 : + - [chris.beams.io/posts/git-commit/](https://chris.beams.io/posts/git-commit/) + - [github.com/blog/1506-closing-issues-via-pull-requests ](https://github.com/blog/1506-closing-issues-via-pull-requests ) + - [davidwalsh.name/squash-commits-git ](https://davidwalsh.name/squash-commits-git ) ## その他の貢献方法 @@ -61,3 +47,12 @@ weight: 80 - 機能開発に貢献したい方は、まずはじめに[Kubernetesコントリビューターチートシート](https://github.com/kubernetes/community/blob/master/contributors/guide/contributor-cheatsheet/README-ja.md)を読んでください。 {{% /capture %}} + +{{% capture whatsnext %}} + +- ドキュメントへの貢献の基本について、さらに知りたい場合は、[貢献の開始](/docs/contribute/start/)を参照してください。 +- 変更を提案をする際は、[Kubernetesドキュメンテーションスタイルガイド](/docs/contribute/style/style-guide/)に従ってください。 +- SIG Docsについて、さらに知りたい場合は、[SIGドキュメントへの参加](/docs/contribute/participating/)を参照してください。 +- Kubernetesドキュメントのローカライズについて、さらに知りたい場合は、[Kubernetesドキュメントのローカライズ](/docs/contribute/localization/)を参照してください。 + +{{% /capture %}}