From 32e0ff51d6a1506389584e811b501d514f4f93e0 Mon Sep 17 00:00:00 2001 From: TAKAHASHI Shuuji Date: Tue, 18 Aug 2020 06:50:14 +0900 Subject: [PATCH 1/3] Copy contribute/style/content-guide.md from en/ directory. --- .../ja/docs/contribute/style/content-guide.md | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 content/ja/docs/contribute/style/content-guide.md diff --git a/content/ja/docs/contribute/style/content-guide.md b/content/ja/docs/contribute/style/content-guide.md new file mode 100644 index 0000000000..0de4a381a3 --- /dev/null +++ b/content/ja/docs/contribute/style/content-guide.md @@ -0,0 +1,77 @@ +--- +title: Documentation Content Guide +linktitle: Content guide +content_type: concept +weight: 10 +--- + + + +This page contains guidelines for Kubernetes documentation. + +If you have questions about what's allowed, join the #sig-docs channel in +[Kubernetes Slack](https://slack.k8s.io/) and ask! + +You can register for Kubernetes Slack at https://slack.k8s.io/. + +For information on creating new content for the Kubernetes +docs, follow the [style guide](/docs/contribute/style/style-guide). + + + + + +## Overview + +Source for the Kubernetes website, including the docs, resides in the +[kubernetes/website](https://github.com/kubernetes/website) repository. + +Located in the `kubernetes/website/content//docs` folder, the +majority of Kubernetes documentation is specific to the [Kubernetes +project](https://github.com/kubernetes/kubernetes). + +## What's allowed + +Kubernetes docs allow content for third-party projects only when: + +- Content documents software in the Kubernetes project +- Content documents software that's out of project but necessary for Kubernetes to function +- Content is canonical on kubernetes.io, or links to canonical content elsewhere + +### Third party content + +Kubernetes documentation includes applied examples of projects in the Kubernetes project—projects that live in the [kubernetes](https://github.com/kubernetes) and +[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizations. + +Links to active content in the Kubernetes project are always allowed. + +Kubernetes requires some third party content to function. Examples include container runtimes (containerd, CRI-O, Docker), +[networking policy](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) (CNI plugins), [Ingress controllers](/docs/concepts/services-networking/ingress-controllers/), and [logging](/docs/concepts/cluster-administration/logging/). + +Docs can link to third-party open source software (OSS) outside the Kubernetes project only if it's necessary for Kubernetes to function. + +### Dual sourced content + +Wherever possible, Kubernetes docs link to canonical sources instead of hosting +dual-sourced content. + +Dual-sourced content requires double the effort (or more!) to maintain +and grows stale more quickly. + +{{< note >}} + +If you're a maintainer for a Kubernetes project and need help hosting your own docs, +ask for help in [#sig-docs on Kubernetes Slack](https://kubernetes.slack.com/messages/C1J0BPD2M/). + +{{< /note >}} + +### More information + +If you have questions about allowed content, join the [Kubernetes Slack](https://slack.k8s.io/) #sig-docs channel and ask! + + + +## {{% heading "whatsnext" %}} + + +* Read the [Style guide](/docs/contribute/style/style-guide). From 0e7433b99cbb434591e4b6c93dd1776cb8765e07 Mon Sep 17 00:00:00 2001 From: TAKAHASHI Shuuji Date: Tue, 18 Aug 2020 06:50:36 +0900 Subject: [PATCH 2/3] Translate contribute/style/content-guide.md into Japanese. --- .../ja/docs/contribute/style/content-guide.md | 67 +++++++------------ 1 file changed, 26 insertions(+), 41 deletions(-) diff --git a/content/ja/docs/contribute/style/content-guide.md b/content/ja/docs/contribute/style/content-guide.md index 0de4a381a3..d1ca24effd 100644 --- a/content/ja/docs/contribute/style/content-guide.md +++ b/content/ja/docs/contribute/style/content-guide.md @@ -1,77 +1,62 @@ --- -title: Documentation Content Guide -linktitle: Content guide +title: ドキュメントコンテンツガイド +linktitle: コンテンツガイド content_type: concept weight: 10 --- -This page contains guidelines for Kubernetes documentation. +このページでは、Kubernetesのドキュメント上のコンテンツのガイドラインを説明します。 -If you have questions about what's allowed, join the #sig-docs channel in -[Kubernetes Slack](https://slack.k8s.io/) and ask! - -You can register for Kubernetes Slack at https://slack.k8s.io/. - -For information on creating new content for the Kubernetes -docs, follow the [style guide](/docs/contribute/style/style-guide). +許可されるコンテンツに関して疑問がある場合は、[Kubernetes Slack](https://slack.k8s.io/)の#sig-docsチャンネルに参加して質問してください！ +Kubernetes Slackには、 から参加登録ができます。 +Kubernetesドキュメントの新しいコンテンツの作成に関する情報については、[スタイルガイド](/docs/contribute/style/style-guide)に従ってください。 -## Overview +## 概要 -Source for the Kubernetes website, including the docs, resides in the -[kubernetes/website](https://github.com/kubernetes/website) repository. +ドキュメントを含むKubernetesのウェブサイトのソースは、[kubernetes/website](https://github.com/kubernetes/website)リポジトリに置かれています。 -Located in the `kubernetes/website/content//docs` folder, the -majority of Kubernetes documentation is specific to the [Kubernetes -project](https://github.com/kubernetes/kubernetes). +Kubernetesの主要なドキュメントは`kubernetes/website/content//docs`フォルダに置かれており、これらは[Kubernetesプロジェクト](https://github.com/kubernetes/kubernetes)を対象としています。 -## What's allowed +## 許可されるコンテンツ -Kubernetes docs allow content for third-party projects only when: +Kubernetesのドキュメントにサードパーティーのコンテンツを掲載することが許されるのは、次の場合のみです。 -- Content documents software in the Kubernetes project -- Content documents software that's out of project but necessary for Kubernetes to function -- Content is canonical on kubernetes.io, or links to canonical content elsewhere +- コンテンツがKubernetesプロジェクト内のソフトウェアのドキュメントとなる場合 +- コンテンツがプロジェクト外のソフトウェアのドキュメントとなるが、Kubernetesを機能させるために必要である場合 +- コンテンツがkubernetes.ioの正規のコンテンツであるか、他の場所の正規のコンテンツへのリンクである場合 -### Third party content +### サードパーティーのコンテンツ -Kubernetes documentation includes applied examples of projects in the Kubernetes project—projects that live in the [kubernetes](https://github.com/kubernetes) and -[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizations. +Kubernetesのドキュメントには、Kubernetesプロジェクト（[kubernetes](https://github.com/kubernetes)および[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizationsに存在するプロジェクト）の適用例が含まれています。 -Links to active content in the Kubernetes project are always allowed. +Kubernetesプロジェクト内のアクティブなコンテンツへのリンクは常に許可されます。 -Kubernetes requires some third party content to function. Examples include container runtimes (containerd, CRI-O, Docker), -[networking policy](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) (CNI plugins), [Ingress controllers](/docs/concepts/services-networking/ingress-controllers/), and [logging](/docs/concepts/cluster-administration/logging/). +Kubernetesを機能させるためには、一部サードパーティーのコンテンツが必要です。たとえば、コンテナランタイム(containerd、CRI-O、Docker)、[ネットワークポリシー](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/)(CNI plugin)、[Ingressコントローラー](/ja/docs/concepts/services-networking/ingress-controllers/)、[ロギング](/docs/concepts/cluster-administration/logging/)などです。 -Docs can link to third-party open source software (OSS) outside the Kubernetes project only if it's necessary for Kubernetes to function. +ドキュメント内で、Kubernetesプロジェクト外のサードパーティーのオープンソースソフトウェア(OSS)にリンクすることができるのは、Kubernetesを機能させるために必要な場合のみです。 -### Dual sourced content +### 情報源が重複するコンテンツ -Wherever possible, Kubernetes docs link to canonical sources instead of hosting -dual-sourced content. +可能な限り、Kubernetesのドキュメントは正規の情報源にリンクするようにし、情報源が重複してしまうようなホスティングは行いません。 -Dual-sourced content requires double the effort (or more!) to maintain -and grows stale more quickly. +情報源が重複したコンテンツは、メンテナンスするために2倍の労力(あるいはそれ以上！)が必要になり、より早く情報が古くなってしまいます。 {{< note >}} -If you're a maintainer for a Kubernetes project and need help hosting your own docs, -ask for help in [#sig-docs on Kubernetes Slack](https://kubernetes.slack.com/messages/C1J0BPD2M/). +あなたがKubernetesのプロジェクトのメンテナーであり、ドキュメントのホスティングに関して手助けが必要なときは、[Kubernetes Slackの#sig-docs](https://kubernetes.slack.com/messages/C1J0BPD2M/)で教えてください。 {{< /note >}} -### More information - -If you have questions about allowed content, join the [Kubernetes Slack](https://slack.k8s.io/) #sig-docs channel and ask! - +### その他の情報 +許可されるコンテンツに関して疑問がある場合は、[Kubernetes Slack](https://slack.k8s.io/)の#sig-docsチャンネルに参加して質問してください！ ## {{% heading "whatsnext" %}} - -* Read the [Style guide](/docs/contribute/style/style-guide). +* [スタイルガイド](/docs/contribute/style/style-guide)を読む From 6282940ff459d87c42298058fcebab60b2593bca Mon Sep 17 00:00:00 2001 From: TAKAHASHI Shuuji Date: Wed, 19 Aug 2020 22:32:24 +0900 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Naoki Oketani --- content/ja/docs/contribute/style/content-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/ja/docs/contribute/style/content-guide.md b/content/ja/docs/contribute/style/content-guide.md index d1ca24effd..eb165ca733 100644 --- a/content/ja/docs/contribute/style/content-guide.md +++ b/content/ja/docs/contribute/style/content-guide.md @@ -29,11 +29,11 @@ Kubernetesのドキュメントにサードパーティーのコンテンツを - コンテンツがKubernetesプロジェクト内のソフトウェアのドキュメントとなる場合 - コンテンツがプロジェクト外のソフトウェアのドキュメントとなるが、Kubernetesを機能させるために必要である場合 -- コンテンツがkubernetes.ioの正規のコンテンツであるか、他の場所の正規のコンテンツへのリンクである場合 +- コンテンツがkubernetes.ioの正規のコンテンツであるか、他の場所の正規のコンテンツへのリンクである場合 ### サードパーティーのコンテンツ -Kubernetesのドキュメントには、Kubernetesプロジェクト（[kubernetes](https://github.com/kubernetes)および[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizationsに存在するプロジェクト）の適用例が含まれています。 +Kubernetesのドキュメントには、Kubernetesプロジェクト([kubernetes](https://github.com/kubernetes)および[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizationsに存在するプロジェクト)の適用例が含まれています。 Kubernetesプロジェクト内のアクティブなコンテンツへのリンクは常に許可されます。