Skip to content

Commit

Permalink
Reorder languages and update related docs
Browse files Browse the repository at this point in the history
Signed-off-by: Dmitry Shurupov <[email protected]>
  • Loading branch information
shurup committed Feb 29, 2024
1 parent 0142fd4 commit 739132a
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 69 deletions.
23 changes: 14 additions & 9 deletions LOCALIZATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,26 +57,31 @@ Open a PR with the localization initiation following this example: https://githu

To add a new language to the site, modify [config.toml](https://github.com/cncf/glossary/blob/main/config.toml#L54) (Note: localization teams should use their assigned development branch for this).

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

- The English language always stays first.
- Other languages are sorted based on the alphabetized English translation of their names (see how currently existing localizations are ordered as an example).
- Each localization is written in its own language followed by the English translation in parentheses — e.g., `한국어 (Korean)`.
- The `weight` parameter in the config is used for sorting (`1` is for English, `2` is for the alphabetically first language, `3` is for the second one, and so on).

For instance, you're adding a new block for the Korean localization. You calculated its weight as 8. Find the language block with `weight = 7` and add your new block afterwards:

- Example of `New language block for /config.toml`
```diff
[languages]
[languages.en]
title = "Cloud Native Glossary"
description = "The CNCF Cloud Native Glossary Project is intended to be used as a reference for common terms used when talking about cloud native applications."
languageName ="English"
# Weight used for sorting.
weight = 1
...
weight = 7

+[languages.ko]
+title = "클라우드 네이티브(Cloud Native) 용어집"
+description = "CNCF 클라우드 네이티브 용어집 프로젝트는 클라우드 네이티브 애플리케이션에 대한 대화를 나눌 때 공통의 용어를 참조하여 사용하도록 하는 목적을 가지고 있다."
+languageName ="한국어(Korean)"
+languageName = "한국어 (Korean)"
+contentDir = "content/ko"
+weight = 2
+weight = 8
```

Since the `weight` values should always be kept consistent, please **remember to increment the weights** of all the languages following your newly added localization.

#### 3-2. Adding a file for site strings

`i18n/<localization>.toml` sets up language-specific site strings.
Expand Down
120 changes: 60 additions & 60 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,85 +68,85 @@ description = "The CNCF Cloud Native Glossary Project is intended to be used as
#time_format_default = "02.01.2006"
#time_format_blog = "02.01.2006"

[languages.bn]
contentDir = "content/bn"
languageName = "বাংলা (Bengali)"
title = "ক্লাউড নেটিভ শব্দকোষ"
weight = 2
[languages.bn.params]
description = "CNCF ক্লাউড নেটিভ শব্দকোষ প্রকল্পটি ক্লাউড নেটিভ অ্যাপ্লিকেশন সম্পর্কে কথা বলার সময় ব্যবহৃত সাধারণ পদগুলির জন্য একটি রেফারেন্স হিসাবে ব্যবহার করার উদ্দেশ্যে।"

[languages.fr]
contentDir = "content/fr"
languageName = "Français (French)"
title = "Glossaire Cloud Native"
weight = 3
[languages.fr.params]
description = "Le projet de Glossaire CNCF Cloud Native a pour objectif de référencer les termes courants utilisés dans les différentes applications Cloud Natives."

[languages.de]
contentDir = "content/de"
languageName = "Deutsch (German)"
title = "Cloud Native Glossar"
weight = 4
[languages.de.params]
description = "Das CNCF Cloud Native Glossar soll als Referenz für gängige Begriffe dienen, die im Zusammenhang mit Cloud Native Anwendungen verwendet werden."

[languages.hi]
contentDir = "content/hi"
languageName = "हिन्दी (Hindi)"
title = "क्लाउड नेटिव शब्दावली"
weight = 2
weight = 5
[languages.hi.params]
description = "CNCF क्लाउड नेटिव शब्दावली परियोजना का उद्देश्य क्लाउड नेटिव एप्लिकेशन के बारे में बात करते समय प्रयोग किए जाने वाले सामान्य शब्दों के संदर्भ के रूप में उपयोग किया जाना है।"

[languages.pt-br]
contentDir = "content/pt-br"
languageName = "Português"
title = "Glossário Cloud Native"
weight = 3
[languages.pt-br.params]
description = "O Projeto CNCF Glossário Cloud Native se destina a ser usado como uma referência para termos comuns usados ao falar sobre aplicações nativas de nuvem."

[languages.it]
contentDir = "content/it"
languageName = "Italiano"
languageName = "Italiano (Italian)"
title = "Glossario Cloud Native"
weight = 4
weight = 6
[languages.it.params]
description = "Il progetto del Glossario CNCF Cloud Native è pensato per essere un riferimento per i termini comuni, usati nell'ambito delle applicazioni cloud native."

[languages.ja]
contentDir = "content/ja"
languageName = "日本語 (Japanese)"
title = "クラウドネイティブ用語集"
weight = 7
[languages.ja.params]
description = "CNCF クラウドネイティブ用語集プロジェクトは、クラウドネイティブアプリケーションについて話すときに使われる一般的な用語のリファレンスとして使用することを目的としています。"

[languages.ko]
contentDir = "content/ko"
languageName = "한국어 (Korean)"
title = "클라우드 네이티브(Cloud Native) 용어집"
weight = 5
weight = 8
[languages.ko.params]
description = "CNCF 클라우드 네이티브 용어집 프로젝트는 클라우드 네이티브 애플리케이션을 주제로 대화를 나눌 때 참조할 수 있는 공통의 용어 제공을 목표로 한다."

[languages.es]
contentDir = "content/es"
languageName = "Español (Spanish)"
title = "Cloud Native Glosario"
weight = 6
[languages.es.params]
description = "El proyecto de CNCF Cloud Native Glosario pretende ser usado como una referencia para los terminos comunes usados cuando se habla acerca de las aplicaciones nativas para la nube."
[languages.pt-br]
contentDir = "content/pt-br"
languageName = "Português (Portuguese)"
title = "Glossário Cloud Native"
weight = 9
[languages.pt-br.params]
description = "O Projeto CNCF Glossário Cloud Native se destina a ser usado como uma referência para termos comuns usados ao falar sobre aplicações nativas de nuvem."

[languages.zh-cn]
contentDir = "content/zh-cn"
languageName = "简体中文 (Simplified Chinese)"
title = "Cloud Native(云原生) Glossary"
weight = 7
weight = 10
[languages.zh-cn.params]
description = "CNCF 云原生 Glossary 项目旨在用作讨论云原生应用程序时常用术语的参考"

[languages.bn]
contentDir = "content/bn"
languageName = "বাংলা (Bengali)"
title = "ক্লাউড নেটিভ শব্দকোষ"
weight = 8
[languages.bn.params]
description = "CNCF ক্লাউড নেটিভ শব্দকোষ প্রকল্পটি ক্লাউড নেটিভ অ্যাপ্লিকেশন সম্পর্কে কথা বলার সময় ব্যবহৃত সাধারণ পদগুলির জন্য একটি রেফারেন্স হিসাবে ব্যবহার করার উদ্দেশ্যে।"

[languages.de]
contentDir = "content/de"
languageName = "Deutsch"
title = "Cloud Native Glossar"
weight = 9
[languages.de.params]
description = "Das CNCF Cloud Native Glossar soll als Referenz für gängige Begriffe dienen, die im Zusammenhang mit Cloud Native Anwendungen verwendet werden."

[languages.ur]
contentDir = "content/ur"
languageName = "اردو (Urdu)"
title = "کلاؤڈ کی مقامی لغت"
weight = 10
[languages.ur.params]
description = "CNCF کلاؤڈ کی مقامی لغت کا مقصد کلاؤڈ مقامی ایپلی کیشنز کے بارے میں بات کرتے وقت استعمال ہونے والی عام اصطلاحات کے حوالے کے طور پر استعمال کرنا ہے۔"

[languages.fr]
contentDir = "content/fr"
languageName = "Français (French)"
title = "Glossaire Cloud Native"
[languages.es]
contentDir = "content/es"
languageName = "Español (Spanish)"
title = "Cloud Native Glosario"
weight = 11
[languages.fr.params]
description = "Le projet de Glossaire CNCF Cloud Native a pour objectif de référencer les termes courants utilisés dans les différentes applications Cloud Natives."
[languages.es.params]
description = "El proyecto de CNCF Cloud Native Glosario pretende ser usado como una referencia para los terminos comunes usados cuando se habla acerca de las aplicaciones nativas para la nube."

[languages.zh-tw]
contentDir = "content/zh-tw"
Expand All @@ -156,21 +156,21 @@ weight = 12
[languages.zh-tw.params]
description = "CNCF 雲端原生 Glossary 專案旨在用作討論雲端原生應用程式時常用術語的參考"

[languages.ja]
contentDir = "content/ja"
languageName = "日本語 (Japanese)"
title = "クラウドネイティブ用語集"
weight = 13
[languages.ja.params]
description = "CNCF クラウドネイティブ用語集プロジェクトは、クラウドネイティブアプリケーションについて話すときに使われる一般的な用語のリファレンスとして使用することを目的としています。"

[languages.tr]
title = "Cloud Native Sözlüğü"
description = "CNCF Cloud Native Sözlüğü projesi, cloud native uygulamalardan bahsederken kullanılan yaygın terimler için bir referans olarak kullanılmak üzere tasarlanmıştır."
languageName ="Türkçe (Turkish)"
contentDir = "content/tr"
# Weight used for sorting.
weight = 13
[languages.tr.params]
description = "CNCF Cloud Native Sözlüğü projesi, cloud native uygulamalardan bahsederken kullanılan yaygın terimler için bir referans olarak kullanılmak üzere tasarlanmıştır."

[languages.ur]
contentDir = "content/ur"
languageName = "اردو (Urdu)"
title = "کلاؤڈ کی مقامی لغت"
weight = 14
[languages.ur.params]
description = "CNCF کلاؤڈ کی مقامی لغت کا مقصد کلاؤڈ مقامی ایپلی کیشنز کے بارے میں بات کرتے وقت استعمال ہونے والی عام اصطلاحات کے حوالے کے طور پر استعمال کرنا ہے۔"

[markup]
[markup.goldmark]
Expand Down

0 comments on commit 739132a

Please sign in to comment.