Embark on Your Localisation Journey

Overview of the translation workflow¶

By translation workflow, we do not refer only to the phases that contributors should follow during the translation process. Instead, we refer to a set of aspects that can lead to a successful and sustainable translation project.

Our current Translation Management System is Crowdin. All translations are stored in a fork of The Turing Way repository inside TWTranslation, a GitHub Organisation account. This fork is updated regularly to fetch new content and Crowdin adds it automatically and starts an automatic translation based on machine translation and translation memory. The automatic translations need review and approval before being accepted.

People in the team complete and review these automatic translations, according to the translation guidelines of each team. New translated and approved files are sent back automatically to the translation fork and will generate a PR to be added to the repository as shown in the figure below.

Most of this process is done automatically, translators do not need to interact with GitHub in any way.

Multideployment of Localised Versions¶

Currently, there is no deployment for the book in different languages due to difficulties with Netlify multi-deployment. The Turing Way will be migrating to a different deployment platform to support multi-deployment of the book. The localisation working group has created a log that contains challenges and updates in their work to streamline the multi-deployment. This log can be accessed on HackMD and is continually updated.

Join the Translation Team in Crowdin¶

• Create an account in our Crowdin project through this link.

You can either create an account in Crowdin by filling the requested details or through sign up using your GitHub, Facebook, X (formerly Twitter), GitLab or Google account.

• Read the landing page of The Turing Way and README to understand the vision and mission of The Turing Way Book.

• Review the Translation Guidelines.

  • What should not be translated for consistency and structural integrity.
  • They are essential to harmonise and standardise translations. Make sure you read them before you start translating for the first time. If you are starting a new language, please make sure you create a repository in the GitHub organisation with your language guidelines. Feel free to comment on these guidelines and suggest new terms anytime. This can be done in the corresponding repositories or in The Turing Way issues.

• Choose the language you want to contribute to. We have currently 4 languages with active contributors, which are Spanish, Arabic, Portuguese and Chinese.

• Start Translating chapters from the translation priorities list.
  • Each language has a Translation Priorities list, which you can find in the README file. Choose one of the high priority files.
  • You can view the translation priorities list in the task tab in Crowdin, they are also marked with a red arrow. The same list is copied below:

    • Urgent (Welcome, afterword)

    • Priority +++ (Overview of the guide of reproducible research, open research)

    • Priority ++ (Research data Management, Research Compendia, Licensing)

    • Priority + (Version Control, Overview of Project Design, Creating Project Repositories)

    • Intermediate (Overview of the Guide for Communication, Making Research Objects Citable, Communications in Open Source Projects, Getting Started With GitHub, Research Infrastructure Roles, Introduction to Research Ethics)

    • In order to navigate to the tasks tab inside Crowdin, you need to click in “Go to the Console” at the top right and navigate back to The Turing Way project which will direct you to a similar interface but with additional tabs on the left. One of these is the task tab. In the Tasks, we assign tasks to get files translated or proofread by the community or set the due dates and receive notifications about the changes and updates in tasks.

• Once you decide which file you will work on, you can type its name in the search bar and click on it. This will direct you to the Crowdin Editor, you will learn more about it in the next chapter.

You are now all set up to start translating The Turing Way. In the next chapter, you will learn how to take advantage of the Crowdin editor to translate strings, proofread or add comments.