Translations Overview

How do translations work?

Workflows

Creating a new file

1. Contributor creates a branch/fork and commits a new markdown file new.md does a PR it gets approved and merged into master and deployed.
2. During that deployment there is no translated markdown file yet so a placeholder will be generated.
3. Sometime later the nightly task will run, pickup this new file and push it to transifex
4. Translators as transifex will get a notification of new files at which point they can login and translate.
5. When they complete the translation 100% then the next nightly task that runs will pick it up and
   • Create a branch from master
   • Commit translated files
   • Create a PR to master from this new branch
   • Add reviewers from baklava

Deleting an existing file

1. Contributor creates a branch/fork and decides to remove a file.md as it is not in use. They do a PR it gets approved and merged into master and deployed.
2. During deployment if the file had a completed translation file a placeholder will NOT get created and if it didn't then a placeholder will still NOT be generated as there will be no english version to create it from.
3. Sometime later the nightly task will run and delete the file from transifex along with its translations if any.

What is a placeholder?

A placeholder is the english content duplicated but with a disclaimer at the top indicating that this page isn't translated yet. This avoids hugo build errors or 404's when navigating the translated site.