Skip to content

Latest commit

 

History

History
82 lines (54 loc) · 4.12 KB

LOCALIZATION.md

File metadata and controls

82 lines (54 loc) · 4.12 KB
Raw

Localization

Contributions to improve the following localization guides and localization policies are very welcome.

Initiating a new localization

Basic requirements to initiate a new localization team

  1. The Cloud Native Maturity Model website does not have a localization for your language yet
  2. Ask in the cartografos-wg channel in Slack. There may be a group of volunteers who haven't gotten started yet. Join your forces!

Instructions to initiate a new localization

1. Join the Slack channel and say hello

If you're interested in creating a new localization, whether you have a team or are on your own, please join the #cartografos-wg channel on the CNCF slack and say hi. If you are looking for additional volunteers, let everyone in the channel know. There may be someone in there looking for a team as well.

2. Configuring a new language

Open a PR with the localization initiation.

2-1. Adding a new language setting to the site configuration

To add a new language to the website, modify config.toml.

The [languages] block of config.toml is used to set the language. For instance, [languages.en] stands for English and [languages.de] for German language configuration. Go to the [languages] block in config.toml and add a new block for your language-specific configuration. For instance, the German localization team added its [languages.de] block after the [languages.en] block.

  • Example of New language block for /config.toml 
    [languages]
[languages.en]
title = "Cloud Native Maturity Model"
description = "The intent of the Cloud Native Maturity Model is to help you move from inception through to full adoption of cloud native technologies using the CNCF landscape to achieve the full benefits of running scalable applications in modern, dynamic environments in public and hybrid clouds."
languageName ="English"
contentDir = "content/en"
# Weight used for sorting.
weight = 1

+[languages.de]
+title = "Cloud Native Maturity Model"
+description = "Das Cloud Native Maturity Model soll Ihnen dabei helfen, sich von den Anfängen bis zur vollständigen Adoption von Cloud Native-Technologien unter Verwendung der CNCF-Landschaft zu bewegen, um alle Vorteile der Ausführung skalierbarer Anwendungen in modernen, dynamischen Umgebungen in öffentlichen und hybriden Clouds zu nutzen."
+languageName = "Deutsch"
+contentDir = "content/de"
+weight = 2

2-2. Add a file for site strings

website/i18n/<localization>.toml sets up language-specific site strings. For a new localization, add a file website/i18n/<localization>.toml based on website/i18n/en.toml. other = "<English site strings>" in website/i18n/<localization>.toml can be translated.

2-3. Add a new localization directory

Translated pages are saved in the appropriate language directory inside website/content/.

Create a subdirectory in content and name it using the appropriate two-letter language code (website/content/<localization>). For example,

contents/en
contents/de
...

It might be a good idea to copy the whole content of contents/en to your new subdirectory (e.g. for spanish contents/es) to ensure the right structure and name of files and then translate file by file.

2-4. Minimum required content

Localize content and save to website/content/<localization>.

Your PR should include all of the pages because it makes no sense to only tranlate part of the Cloud Native Maturity Model.

2-5. Check configuration works and open a PR

Before opening a PR, ensure the website with the updated configuration works by running Hugo server. If it does, select the new language on the local website.

Open a PR and wait for it to be reviewed by the maintainers.

3. Merge the PR branch into main branch

Once the PR is merged, the localized content will go live on the website 🎉