Localizing Helm Documentation
This guide explains how to localize the Helm documentation.
Contributions for translations use the same process as contributions for documentation. Translations are supplied through pull requests to the helm-www git repository and pull requests are reviewed by the team that manages the website.
Two-letter Language Code
Documentation is organized by the
standard for the
language codes. For example, the two-letter code for Korean is
In content and configuration you will find the language code in use. Here are 3 examples:
- In the
contentdirectory the language codes are the subdirectories and the localized content for the language is in each directory. Primarily in the
docssubdirectory of each language code directory.
i18ndirectory contains a configuration file for each language with phrases used on the website. The files are named with the patter
[LANG]is the two letter language code.
- In the top level
config.tomlfile there is configuration for navigation and other details organized by language code.
English, with a language code of
en, is the default language and source for
Fork, Branch, Change, Pull Request
By default your fork will be set to work on the default branch known as master. Please use branches to develop your changes and create pull requests. If you are unfamiliar with branches you can read about them in the GitHub documentation.
Once you have a branch make changes to add translations and localize the content to a language.
Note, Helm uses a
Developers Certificate of
Origin. All commits need to have signoff.
When making a commit you can use the
--signoff flag to use your Git
configured name and email address to signoff on the commit. More details are
available in the
When you are ready, create a pull request with the translation back to the helm-www repository.
Once a pull request has been created one of the maintainers will review it. Details on that process are in the CONTRIBUTING.md file.
Localizing all of the Helm content is a large task. It is ok to start small. The translations can be expanded over time.
Starting A New Language
When starting a new language there is a minimum needed. This includes:
- Adding a
content/[LANG]/docsdirectory containing an
_index.mdfile. This is the top level documentation landing page.
- Creating a
[LANG].tomlfile in the
i18ndirectory. Initially you can copy the
en.tomlfile as a starting point.
- Adding a section for the language to the
config.tomlfile to expose the new language. An existing language section can serve as a starting point.
Translated content needs to reside in the
content/[LANG]/docs directory. It
should have the same URL as the English source. For example, to translate the
intro into Korean it can be useful to copy the english source like:
mkdir -p content/ko/docs/intro cp content/en/docs/intro/install.md content/ko/docs/intro/install.md
The content in the new file can then be translated into the other language.
Note, translation tools can help with the process. This includes machine generated translations. Machine generated translations should be edited or otherwise reviewing for grammar and meaning by a native language speaker before publishing.
Navigating Between Languages
The site global config.toml file is where language navigation is configured.
To add a new language, add a new set of parameters using the two-letter language code defined above. Example:
# Korean [languages.ko] title = "Helm" description = "Helm - The Kubernetes Package Manager." contentDir = "content/ko" languageName = "한국어 Korean" weight = 1
Resolving Internal Links
Translated content will sometimes include links to pages that only exist in another language. This will result in site build errors. Example:
12:45:31 PM: htmltest started at 12:45:30 on app 12:45:31 PM: ======================================================================== 12:45:31 PM: ko/docs/chart_template_guide/accessing_files/index.html 12:45:31 PM: hash does not exist --- ko/docs/chart_template_guide/accessing_files/index.html --> #basic-example 12:45:31 PM: ✘✘✘ failed in 197.566561ms 12:45:31 PM: 1 error in 212 documents
To resolve this, you need to check your content for internal links.
- anchor links need to reflect the translated
- internal page links need to be fixed
For internal pages that do not exist (or have not been translated yet), the site will not build until a correction is made. As a fallback, the url can point to another language where that content does exist as follows:
< relref path="/docs/topics/library_charts.md" lang="en" >
See the Hugo Docs on cross references between languages for more info.