Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initialize Localization READMEs template #260

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/localization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
82 changes: 82 additions & 0 deletions docs/localization/TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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).
Loading