From e746b801d7623625f1d8b15463603d236d51dfdc Mon Sep 17 00:00:00 2001 From: Junya Okabe Date: Sun, 16 Jun 2024 00:41:21 +0900 Subject: [PATCH 01/11] feat: initialize Japanese l10n guide Signed-off-by: Junya Okabe --- docs/localization/ja/README.md | 65 ++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 docs/localization/ja/README.md diff --git a/docs/localization/ja/README.md b/docs/localization/ja/README.md new file mode 100644 index 0000000..68ca092 --- /dev/null +++ b/docs/localization/ja/README.md @@ -0,0 +1,65 @@ +# CNCF日本語ローカライゼーション向けガイドライン + +このドキュメントでは、CNCFのプロジェクトをローカライズする際に参考になる一般的なガイドラインを提供します。 + +> [!IMPORTANT] +> プロジェクトによっては適用できない場合もあります。各プロジェクトのメンテナーやコミュニティ、日本語ローカライゼーションのリードと適宜相談してください。 + +## 目次 {#table-of-contents} + +- [スタイルガイド](#style-guide) +- [固有の用語](#specific-terms) + - [例](#specific-terms-example) +- [プロジェクト](#projects) +- [コミュニケーション](#communication) + +## スタイルガイド {#style-guide} + +Kubernetesの[日本語ローカライゼーション向けのスタイルガイド](https://kubernetes.io/ja/docs/contribute/localization/#style-guide)に準拠してください。 + +## 固有の用語 {#specific-terms} + +CNCFのプロジェクト特有の用語については、原則として英語のまま表記してください。ただしこれらの用語や概念を説明をするページなどで日本語の訳語が必要な場合は、以下の表を参考にしてください。 + +| 英語 | 日本語 | +| --- | --- | +| Charter | チャーター | +| Governing Board | 運営委員会 | +| SIG (Special Interest Group) | Special Interest Group | +| TAB (Technical Advisory Board) | 技術諮問評議会 | +| TAG (Technical Advisory Group) | 技術諮問グループ | +| TOC (Technical Oversight Committee) | 技術監督委員会 | +| WG (Working Group) | ワーキンググループ | + +また次の表に示す用語はCNCF特有ではありませんが、表記を統一するため、原則として以下の表を参考にしてください。 + +| 英語 | 日本語 | +| --- | --- | +| Committee | 委員会 | +| White Paper | ホワイトペーパー | + +### 例 {#specific-terms-example} + +| 推奨 | 非推奨 | +| --- | --- | +| Platform WG | プラットフォームWG | +| Platform WG | プラットフォームワーキンググループ | +| SIG Docs | SIGドキュメント | +| TAG Runtime | TAGランタイム | + +## プロジェクト {#projects} + +すでにローカライゼーションが進められているプロジェクトの一覧です。ローカライゼーションPRを作成する際には、以下の表を参考にして、適宜ローカライゼーションリードやレビュアーに通知してください。 + +| プロジェクト | URL | ローカライゼーションリード | ローカライゼーションレビュアー | +| --- | --- | --- | --- | +| CNCF Glossary | https://github.com/cncf/glossary | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | +| CNCF TAG App Delivery | https://github.com/cncf/tag-app-delivery | [@hhiroshell](https://github.com/hhiroshell) | [@hhiroshell](https://github.com/hhiroshell), [@kaitoii11](https://github.com/kaitoii11), [@naonishijima](https://github.com/naonishijima) | +| CNCF TAG Environmental Sustainability | https://github.com/cncf/tag-env-sustainability | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | +| CNCF TAG Runtime | https://github.com/cncf/tag-runtime | [@kaitoii11](https://github.com/kaitoii11) | [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | + +## コミュニケーション {#communication} + +CNCFのプロジェクトのローカライゼーションに関するコミュニケーションは、主に、[CNCFのSlack](cloud-native.slack.com)の[`#glossary-localization-japanese`](https://cloud-native.slack.com/archives/C057F81GFUG)チャンネルで行われています。ローカライゼーションに関する質問や提案がある場合は、こちらのチャンネルで議論してください。 + +CNCFのSlackに参加していない場合は、[Community Inviterのサイト](https://communityinviter.com/apps/cloud-native/cncf)から参加できます。 From 4af479eba33ccab0e4de4441a475b50bc32b896e Mon Sep 17 00:00:00 2001 From: Junya Okabe Date: Sun, 16 Jun 2024 01:19:17 +0900 Subject: [PATCH 02/11] update: add review section Signed-off-by: Junya Okabe --- docs/localization/ja/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/localization/ja/README.md b/docs/localization/ja/README.md index 68ca092..f78f8be 100644 --- a/docs/localization/ja/README.md +++ b/docs/localization/ja/README.md @@ -10,6 +10,7 @@ - [スタイルガイド](#style-guide) - [固有の用語](#specific-terms) - [例](#specific-terms-example) +- [レビュー](#review) - [プロジェクト](#projects) - [コミュニケーション](#communication) @@ -47,6 +48,13 @@ CNCFのプロジェクト特有の用語については、原則として英語 | SIG Docs | SIGドキュメント | | TAG Runtime | TAGランタイム | +## レビュー {#review} + +ローカライゼーションのPRを作成した際は、ローカライゼーションレビュアーにレビューを依頼してください。各リポジトリのレビュアーは、[プロジェクト](#projects)の表を参考にしてください。 +2人以上のローカライゼーションレビュアーからの承認を得ることを推奨します。 + +ローカライゼーションレビュアーからの承認を得た後、各リポジトリのメンテナーにPRのマージを依頼してください。 + ## プロジェクト {#projects} すでにローカライゼーションが進められているプロジェクトの一覧です。ローカライゼーションPRを作成する際には、以下の表を参考にして、適宜ローカライゼーションリードやレビュアーに通知してください。 From 3c30feb2f2053fbc3bfde42664e8715c78b4c3ba Mon Sep 17 00:00:00 2001 From: Junya Okabe Date: Sun, 16 Jun 2024 01:29:37 +0900 Subject: [PATCH 03/11] fix: anchor link Signed-off-by: Junya Okabe --- docs/localization/ja/README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/localization/ja/README.md b/docs/localization/ja/README.md index f78f8be..b85f4d9 100644 --- a/docs/localization/ja/README.md +++ b/docs/localization/ja/README.md @@ -5,20 +5,20 @@ > [!IMPORTANT] > プロジェクトによっては適用できない場合もあります。各プロジェクトのメンテナーやコミュニティ、日本語ローカライゼーションのリードと適宜相談してください。 -## 目次 {#table-of-contents} +## 目次 -- [スタイルガイド](#style-guide) -- [固有の用語](#specific-terms) - - [例](#specific-terms-example) -- [レビュー](#review) -- [プロジェクト](#projects) -- [コミュニケーション](#communication) +- [スタイルガイド](#スタイルガイド) +- [固有の用語](#固有の用語) + - [例](#例) +- [レビュー](#レビュー) +- [プロジェクト](#プロジェクト) +- [コミュニケーション](#コミュニケーション) -## スタイルガイド {#style-guide} +## スタイルガイド Kubernetesの[日本語ローカライゼーション向けのスタイルガイド](https://kubernetes.io/ja/docs/contribute/localization/#style-guide)に準拠してください。 -## 固有の用語 {#specific-terms} +## 固有の用語 CNCFのプロジェクト特有の用語については、原則として英語のまま表記してください。ただしこれらの用語や概念を説明をするページなどで日本語の訳語が必要な場合は、以下の表を参考にしてください。 @@ -39,7 +39,7 @@ CNCFのプロジェクト特有の用語については、原則として英語 | Committee | 委員会 | | White Paper | ホワイトペーパー | -### 例 {#specific-terms-example} +### 例 | 推奨 | 非推奨 | | --- | --- | @@ -48,14 +48,14 @@ CNCFのプロジェクト特有の用語については、原則として英語 | SIG Docs | SIGドキュメント | | TAG Runtime | TAGランタイム | -## レビュー {#review} +## レビュー -ローカライゼーションのPRを作成した際は、ローカライゼーションレビュアーにレビューを依頼してください。各リポジトリのレビュアーは、[プロジェクト](#projects)の表を参考にしてください。 +ローカライゼーションのPRを作成した際は、ローカライゼーションレビュアーにレビューを依頼してください。各リポジトリのレビュアーは、[プロジェクト](#プロジェクト)の表を参考にしてください。 2人以上のローカライゼーションレビュアーからの承認を得ることを推奨します。 ローカライゼーションレビュアーからの承認を得た後、各リポジトリのメンテナーにPRのマージを依頼してください。 -## プロジェクト {#projects} +## プロジェクト すでにローカライゼーションが進められているプロジェクトの一覧です。ローカライゼーションPRを作成する際には、以下の表を参考にして、適宜ローカライゼーションリードやレビュアーに通知してください。 @@ -66,7 +66,7 @@ CNCFのプロジェクト特有の用語については、原則として英語 | CNCF TAG Environmental Sustainability | https://github.com/cncf/tag-env-sustainability | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | | CNCF TAG Runtime | https://github.com/cncf/tag-runtime | [@kaitoii11](https://github.com/kaitoii11) | [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | -## コミュニケーション {#communication} +## コミュニケーション CNCFのプロジェクトのローカライゼーションに関するコミュニケーションは、主に、[CNCFのSlack](cloud-native.slack.com)の[`#glossary-localization-japanese`](https://cloud-native.slack.com/archives/C057F81GFUG)チャンネルで行われています。ローカライゼーションに関する質問や提案がある場合は、こちらのチャンネルで議論してください。 From eded7d6321c813e0c40c9f486fd7755708739bba Mon Sep 17 00:00:00 2001 From: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> Date: Mon, 17 Jun 2024 17:12:56 +0900 Subject: [PATCH 04/11] Update: l10n reviewer Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> Signed-off-by: Junya Okabe --- docs/localization/ja/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/localization/ja/README.md b/docs/localization/ja/README.md index b85f4d9..168b463 100644 --- a/docs/localization/ja/README.md +++ b/docs/localization/ja/README.md @@ -64,7 +64,7 @@ CNCFのプロジェクト特有の用語については、原則として英語 | CNCF Glossary | https://github.com/cncf/glossary | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | | CNCF TAG App Delivery | https://github.com/cncf/tag-app-delivery | [@hhiroshell](https://github.com/hhiroshell) | [@hhiroshell](https://github.com/hhiroshell), [@kaitoii11](https://github.com/kaitoii11), [@naonishijima](https://github.com/naonishijima) | | CNCF TAG Environmental Sustainability | https://github.com/cncf/tag-env-sustainability | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | -| CNCF TAG Runtime | https://github.com/cncf/tag-runtime | [@kaitoii11](https://github.com/kaitoii11) | [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | +| CNCF TAG Runtime | https://github.com/cncf/tag-runtime | [@kaitoii11](https://github.com/kaitoii11) | [@kaitoii11](https://github.com/kaitoii11), [@kenta-iijima](https://github.com/kenta-iijima), [@Okabe-Junya](https://github.com/Okabe-Junya) | ## コミュニケーション From cb511eaa5c01020a71c11f6e7515667d247a131b Mon Sep 17 00:00:00 2001 From: Junya Okabe Date: Tue, 18 Jun 2024 03:14:43 +0900 Subject: [PATCH 05/11] fix: linter errors Signed-off-by: Junya Okabe --- docs/localization/ja/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/localization/ja/README.md b/docs/localization/ja/README.md index 168b463..a78bd39 100644 --- a/docs/localization/ja/README.md +++ b/docs/localization/ja/README.md @@ -59,12 +59,12 @@ CNCFのプロジェクト特有の用語については、原則として英語 すでにローカライゼーションが進められているプロジェクトの一覧です。ローカライゼーションPRを作成する際には、以下の表を参考にして、適宜ローカライゼーションリードやレビュアーに通知してください。 -| プロジェクト | URL | ローカライゼーションリード | ローカライゼーションレビュアー | -| --- | --- | --- | --- | -| CNCF Glossary | https://github.com/cncf/glossary | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | -| CNCF TAG App Delivery | https://github.com/cncf/tag-app-delivery | [@hhiroshell](https://github.com/hhiroshell) | [@hhiroshell](https://github.com/hhiroshell), [@kaitoii11](https://github.com/kaitoii11), [@naonishijima](https://github.com/naonishijima) | -| CNCF TAG Environmental Sustainability | https://github.com/cncf/tag-env-sustainability | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | -| CNCF TAG Runtime | https://github.com/cncf/tag-runtime | [@kaitoii11](https://github.com/kaitoii11) | [@kaitoii11](https://github.com/kaitoii11), [@kenta-iijima](https://github.com/kenta-iijima), [@Okabe-Junya](https://github.com/Okabe-Junya) | +| プロジェクト | ローカライゼーションリード | ローカライゼーションレビュアー | +| --- | --- | --- | +| [CNCF Glossary](https://github.com/cncf/glossary) | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | +| [CNCF TAG App Delivery](https://github.com/cncf/tag-app-delivery) | [@hhiroshell](https://github.com/hhiroshell) | [@hhiroshell](https://github.com/hhiroshell), [@kaitoii11](https://github.com/kaitoii11), [@naonishijima](https://github.com/naonishijima) | +| [CNCF TAG Environmental Sustainability](https://github.com/cncf/tag-env-sustainability) | [@naonishijima](https://github.com/naonishijima) | [@naonishijima](https://github.com/naonishijima), [@kaitoii11](https://github.com/kaitoii11), [@Okabe-Junya](https://github.com/Okabe-Junya) | +| [CNCF TAG Runtime](https://github.com/cncf/tag-runtime) | [@kaitoii11](https://github.com/kaitoii11) | [@kaitoii11](https://github.com/kaitoii11), [@kenta-iijima](https://github.com/kenta-iijima), [@Okabe-Junya](https://github.com/Okabe-Junya) | ## コミュニケーション From bb84976125b46934604070bf0be76448f275bcee Mon Sep 17 00:00:00 2001 From: Junya Okabe Date: Tue, 18 Jun 2024 03:27:02 +0900 Subject: [PATCH 06/11] feat: add ## Localization READMEs Signed-off-by: Junya Okabe --- docs/localization/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/localization/README.md b/docs/localization/README.md index aae60c1..eda6024 100644 --- a/docs/localization/README.md +++ b/docs/localization/README.md @@ -11,3 +11,9 @@ Every guide here must meet the following requirements: - Meets the requirements of the original open-source license. Guides here must not violate copyright or licensing requirements. + +## Localization READMEs + +| Language | File | +| -------- | ---------------------------- | +| Japanese | [ja/README.md](ja/README.md) | From 40e81919a48dce60c678c999eb2b1babc376328e Mon Sep 17 00:00:00 2001 From: Junya Okabe Date: Tue, 18 Jun 2024 16:30:57 +0900 Subject: [PATCH 07/11] fix: link checker error Signed-off-by: Junya Okabe --- docs/localization/ja/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/localization/ja/README.md b/docs/localization/ja/README.md index a78bd39..22424e1 100644 --- a/docs/localization/ja/README.md +++ b/docs/localization/ja/README.md @@ -68,6 +68,6 @@ CNCFのプロジェクト特有の用語については、原則として英語 ## コミュニケーション -CNCFのプロジェクトのローカライゼーションに関するコミュニケーションは、主に、[CNCFのSlack](cloud-native.slack.com)の[`#glossary-localization-japanese`](https://cloud-native.slack.com/archives/C057F81GFUG)チャンネルで行われています。ローカライゼーションに関する質問や提案がある場合は、こちらのチャンネルで議論してください。 +CNCFのプロジェクトのローカライゼーションに関するコミュニケーションは、主に、[CNCFのSlack](https://cloud-native.slack.com)の[`#glossary-localization-japanese`](https://cloud-native.slack.com/archives/C057F81GFUG)チャンネルで行われています。ローカライゼーションに関する質問や提案がある場合は、こちらのチャンネルで議論してください。 CNCFのSlackに参加していない場合は、[Community Inviterのサイト](https://communityinviter.com/apps/cloud-native/cncf)から参加できます。 From e2e6bf10fbda711801d0e6fceb5e3f0f0fe2695a Mon Sep 17 00:00:00 2001 From: Junya Okabe Date: Tue, 18 Jun 2024 16:33:13 +0900 Subject: [PATCH 08/11] update: .prettierignore Signed-off-by: Junya Okabe --- .prettierignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.prettierignore b/.prettierignore index ec634b6..d6c332f 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1,2 @@ -# Nothing to ignore at the moment. +# prettier doesn't work well with Japanese +docs/localization/ja/README.md From e16bf43cf403d5e09ec50df251e24911bde763ac Mon Sep 17 00:00:00 2001 From: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> Date: Fri, 28 Jun 2024 17:36:39 +0900 Subject: [PATCH 09/11] Update docs/localization/README.md Co-authored-by: Patrice Chalin Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> --- docs/localization/README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/localization/README.md b/docs/localization/README.md index eda6024..9ca8025 100644 --- a/docs/localization/README.md +++ b/docs/localization/README.md @@ -12,8 +12,6 @@ Every guide here must meet the following requirements: Guides here must not violate copyright or licensing requirements. -## Localization READMEs +## Localizations -| Language | File | -| -------- | ---------------------------- | -| Japanese | [ja/README.md](ja/README.md) | +- [Japanese](ja/README.md) From 458087c07bb25e74417e5ee5f74586c8938b5613 Mon Sep 17 00:00:00 2001 From: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> Date: Fri, 28 Jun 2024 17:37:13 +0900 Subject: [PATCH 10/11] Update .prettierignore Co-authored-by: Patrice Chalin Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> --- .prettierignore | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.prettierignore b/.prettierignore index d6c332f..f238ae8 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,2 +1 @@ -# prettier doesn't work well with Japanese -docs/localization/ja/README.md +/docs/localization/ja From f4b493d48a6060187c137d5950eede700bd0c6cd Mon Sep 17 00:00:00 2001 From: Junya Okabe Date: Fri, 28 Jun 2024 18:07:12 +0900 Subject: [PATCH 11/11] fix: L6 Signed-off-by: Junya Okabe --- docs/localization/ja/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/localization/ja/README.md b/docs/localization/ja/README.md index 22424e1..265ff8b 100644 --- a/docs/localization/ja/README.md +++ b/docs/localization/ja/README.md @@ -3,7 +3,7 @@ このドキュメントでは、CNCFのプロジェクトをローカライズする際に参考になる一般的なガイドラインを提供します。 > [!IMPORTANT] -> プロジェクトによっては適用できない場合もあります。各プロジェクトのメンテナーやコミュニティ、日本語ローカライゼーションのリードと適宜相談してください。 +> 各プロジェクトに対してこのガイドラインをどの程度適用するかは、各プロジェクトのローカライゼーションリードが決定します。疑問点がある場合は、各プロジェクトの日本語ローカライゼーションリードやレビュアーと相談してください。 ## 目次