From 292a695fc91ff2948f12570ebf70065cd4521dca Mon Sep 17 00:00:00 2001 From: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> Date: Tue, 18 Jun 2024 04:08:47 +0900 Subject: [PATCH 1/2] feat: add localization template Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> --- docs/localization/TEMPLATE.md | 82 +++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 docs/localization/TEMPLATE.md diff --git a/docs/localization/TEMPLATE.md b/docs/localization/TEMPLATE.md new file mode 100644 index 0000000..e0bd58b --- /dev/null +++ b/docs/localization/TEMPLATE.md @@ -0,0 +1,82 @@ +# CNCF Localization Guidelines Template + +This document provides general guidelines to refer to when localizing CNCF +projects. + +> [!IMPORTANT] These guidelines may not be applicable to all projects. Please +> consult with the maintainers of each project, the community, or the lead for +> localization as needed. + +## Table of Contents + +- [CNCF Localization Guidelines Template](#cncf-localization-guidelines-template) + - [Table of Contents](#table-of-contents) + - [Style Guide](#style-guide) + - [Specific Terms](#specific-terms) + - [Examples](#examples) + - [Review](#review) + - [Projects](#projects) + - [Communication](#communication) + +## Style Guide + +Please follow the "Localization Style Guide" relevant to your language and +project. + +`<Put a link to the style guide here>` + +## Specific Terms + +For terms specific to CNCF projects, they should generally be left in English. +However, if you need to provide translations for these terms or concepts on +explanatory pages, please refer to the table below. + +| English | Translated | +| ----------------------------------- | ------------------------ | +| Charter | `<put translation here>` | +| Governing Board | ... | +| SIG (Special Interest Group) | ... | +| TAB (Technical Advisory Board) | ... | +| TAG (Technical Advisory Group) | ... | +| TOC (Technical Oversight Committee) | ... | +| WG (Working Group) | ... | +| ... | ... | + +### Examples + +| Recommended | Not Recommended | +| ------------------------------------ | ---------------------------------------- | +| `<put recommended translation here>` | `<put not recommended translation here>` | +| ... | ... | + +## Review + +When creating a localization PR, request a review from the localization +reviewers. Refer to the [Projects](#projects) table for reviewers in each +repository. It is recommended to obtain approval from at least two localization +reviewers. + +After obtaining approval from the localization reviewers, request the +maintainers of each repository to merge the PR. + +## Projects + +This is a list of projects where localization is already in progress. When +creating a localization PR, refer to the table below and notify the localization +lead and reviewers as needed. + +| Project | Localization Lead | Localization Reviewers | +| ----------------------------------------------------------------- | ---------------------- | ---------------------- | +| [CNCF Glossary](https://github.com/cncf/glossary) | `<put lead name here>` | `<put reviewers here>` | +| [CNCF TAG App Delivery](https://github.com/cncf/tag-app-delivery) | ... | ... | +| ... | ... | ... | + +## Communication + +Communication regarding localization of CNCF projects mainly takes place in the +relevant channel on the [CNCF Slack](https://cloud-native.slack.com). If you have any +questions or suggestions about localization, please discuss them in this +channel, `<put channel name here>`. + +If you are not a member of the CNCF Slack, you can join via the +[Community Inviter site](https://communityinviter.com/apps/cloud-native/cncf). From ae37ec228667a5584c3dd671c0c4f8fb405972ca Mon Sep 17 00:00:00 2001 From: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> Date: Tue, 18 Jun 2024 04:17:40 +0900 Subject: [PATCH 2/2] update: docs/localization/README.md Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> --- docs/localization/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/localization/README.md b/docs/localization/README.md index aae60c1..e4fe533 100644 --- a/docs/localization/README.md +++ b/docs/localization/README.md @@ -11,3 +11,8 @@ 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. + +## Templates + +[TEMPLATE.md](TEMPLATE.md) is a template for creating new localization guides. +You can copy this template and use it to create new guides.