Deployment of the TTW Localisation

Localisation in the TTW is an ongoing process.
For more documentaion about localisation workflow/tools, see the Turning Way community handbook: link.

The aim of this documentation is to track progress and the deployment of the localisation Infrastructure. It helps the infrastructure working group and contributors understand the current status.

Localisation repository

This is the Localisation Repository. More info can be found in Turning Way community handbook.

All translations are stored in a fork of The Turing Way repository within the TWTranslation GitHub Organisation account. This fork is regularly updated to fetch new content, and Crowdin adds it automatically, starting with machine translation and translation memory.

Why is the localisation carried out in a fork outside the main repositories?

This step was implemented to mitigate the risk of experimenting with the main repository back in 2022 before the TTW moved to its own GitHub organisation account. We plan to move it to the TTW GitHub organisation after ensuring the multi-deployment and workflow are working.

Summary of challanges as of 6 June 2024

The TTW book is synced with Crowdin for translation. After each successful translation, a pull request is made from Crowdin to the repository.

It is important to note that TTW will move from Netlify to Read the Docs: Read the Docs.
In the past, we had problems with multi-deployment via Netlify. We could only deploy one repository at a time, like English or Arabic only.

An example of a single deployment is this Arabic deployment, carried out separately in a different repository here.

Currently, in the main translation repo, PRs generated after localisation don't reflect the TOC so far, so some translations don’t have all the files needed for deployment. There is an ongoing ticket with Crowdin, updated in June 2024.

Our current problem is that we can't do multi-deployment with Netlify. Contributors are working on Crowdin but don’t see the translation on the website.

TTW in Crowdin: TTW in Crowdin

To experiment with the workflow, our contributors synced three repositories (all forks) to Crowdin.

Image Not Showing Possible Reasons
  • The image was uploaded to a note which you don't have access to
  • The note which the image was originally uploaded to has been deleted
Learn More →

Please note that this is just an experiment and both RealRichie.ttw.multideployment and sandyguide-Arabic.TW-test are temporary and will be removed. They don't interfere with the localisation process.

  • Multi-deployment via Netlify: Netlify does not accept multiple builds for one repository. We can only deploy one repository at a time, like English or Arabic only.
  • Deployment from different branches leads to complexities on Crowdin.
  • PRs don't reflect all files like toc.yml so far, so some translations don’t have all the files needed for deployment.
  • Contributors are working on Crowdin but don’t see the translation on the website.

Contact

As of June 2024, Richie Maluch, Goodnews sandy, and Batool Almarzouq are the contacts for understanding the infrastructure work of the localisation.

Select a repo