Table of Contents

• Introduction
• Progress of Translations
• Preview Translations
• Maintainers
• Support this Project
• Sponsorship
• Code Contributors
• Financial Contributors
• Translation Disclaimer
• Licenses

Introduction

The goal of this project is to translate the ROS 2 documentation into multiple languages. Translations are contributed via the Crowdin platform and automatically synchronized with the GitHub repository. Translations can be previewed on GitHub Pages.

GitHub Workflows
Status	Description
	Build documents by Sphinx and upload build artifacts.
	Update .pot files by Sphinx with gettext builder.
	Update .po files from .pot files by Gettext toolkit.
	Update .po files from the compendium by Gettext toolkit.
	Update statistics information of .po files by Gettext toolkit.
	Upload .pot files to Crowdin by its CLI tool.
	Download .po files from Crowdin by its CLI tool.
	Update docs translations by Crowdin CLI tool.
	Download and deploy build artifacts to pages branch.
	Deploy .po files to po/${VERSION} branch.
	Update the copyright year in LICENSE to the current year.
	Update each of the submodules to their latest commit.

Progress of Translations

Locale	English Name Native Name	Translated Proofread
zh_CN	Simplified Chinese 简体中文
zh_TW	Traditional Chinese 繁體中文

Preview Translations

You can preview translations in GitHub Pages:

You can switch to other available languages and versions by the flyout navigation menu.

Maintainers

This project is currently maintained by:

Support this Project

You can contribute and support this project by doing any of the following:

• Star the project on GitHub or other mirrors.
• Submit issues on GitHub if you found any bug.
• Submit pull requests on GitHub if you know how to fix the bug.
• Contribute your translations on Crowdin.
• If you love this kind of l10n projects, please consider sponsorship.

It will facilitate the creation and ongoing maintenance of l10n projects for open-source documentation.

Sponsorship

You can sponsor the maintainers directly through the following platforms:

Haowei Hsu
Patreon	Afdian

Code Contributors

Financial Contributors

Translation Disclaimer

Translators who contribute to this project will never make use of the copyright on his or her translations, will never forbid copying them, and will never ask for some kind of compensation. Everyone will always be allowed to freely use, modify, and distribute these translations.

Licenses

All CMake script files (e.g., CMakeLists.txt, CMakePresets.json, and cmake/**/* files), GitHub workflow files (e.g., .github/workflows/*.yml files), and configuration files (e.g., versions.json, languages.json, crowdin.yml, and so on) of this project are licensed under 3-Clause BSD license. See LICENSE-BSD for details.

All document files (e.g., README.md) of this project are licensed under Creative Commons Attribution-ShareAlike 4.0 International license. See LICENSE-CC for details.