Internationalisation (i18n)
This section covers internationalisation aspects of the ClickHouse docs website.
ClickHouse documentation is written in English. The English documentation is then translated using an LLM using General Translation as the service provider. When a change is made to the English docs, the General Translation agent will detect the changes and automatically open a PR with the translations.
We support the following languages on our docs:
- English
- Japanese
- Chinese
- Russian
Whilst we try our best to provide high quality translations by actively maintaining a glossary of terms and their corresponding translations, you may still spot mistakes or awkward translations. If you've spotted a mistake, please create an issue in this repo using the template for translation issues, or better yet open a PR with the correction. Any updates made to the translated documents will be taken into account if the agent retranslates that page in future.
We are open to taking requests for new languages, and will add new languages if there is sufficient interest. Search the repository issues to see if there is currently a request for the language you want added. If there is, add a thumbs up to the issue, or else create a new issue with the request.
Our setup mostly follows the opinionated approach of Docusaurus to i18n in that translations live in the i18n directory. There are however a couple of caveats.
Rather than a single Vercel deployment we have a Vercel deployment per translation. When you open a pull request, you will notice that translation builds will be skipped:
This is because on the Vercel translation deployments we an ignored build step condition:
git diff HEAD^ HEAD --quiet -- ./i18n/{locale}&& git diff HEAD^ HEAD --quiet -- docusaurus.config.{locale}.js && exit 0 || exit 1
This ensures that only changes to the i18n directory or to the language specific Docusaurus config files trigger a build of a translation site.