Localizations

Introduction

Part of what makes the CNCF so amazing is the diversity of people involved and supported by the community. One way we make this community more inclusive is by providing localizations for content where possible. Localizations of course require native speakers to create and maintain them and this post is about how you can do that within the CNPE Community content.

The Platform Engineering artifacts and website are initially developed in English, but we welcome contributions to prepare them for other languages. This is a great way to help make the content accessible to a wider audience and to contribute to the community.

Guidelines

While each localization is unique, we encourage you to familiarlize yourself with past localization PRs and the Kubernetes SIG-Docs localization documentation for general guidelines and lessons learned.

To help maintain translation quality and consistency, each localization language should have at least one localization committer. These reviewers are managed through the corresponding language directory’s CODEOWNERS file.

The general localization workflow is:

1. Optionally open an issue
2. Open a PR
3. Have the PR reviewed by at least one localization committer for that language
   • Check grammar, syntax, and overall language quality
   • Verify the accuracy of the translation
4. Merge

It is worth reiterating what the SIG-Docs team has stated:

Localizing all the Kubernetes documentation is an enormous task. It’s okay to start small and expand over time.

Whether you start with a single white paper, or want to expand on an existing language to include more blog posts or content, every little bit will make a difference and is appreciated!

Contributing

To get started, please open an issue on the CNPE Community GitHub repository using the Website Localization issue type.

This issue type will provide context on the scope of your work and provide guidance on the steps required to complete a localizations.