Skip to content
This repository has been archived by the owner on Feb 5, 2023. It is now read-only.

Publishing workflow

Pablo Collado edited this page Aug 4, 2020 · 1 revision

Publishing Workflow

In order for the programmers to be able to test the program with real samples we believe it would be great to have a clearer understanding of how publishers work and handle the translations.

We mustn't forget the projects we are all translating are pulled (obtained) from a GitHub repository and they are pushed (uploaded) to them too. An example repository can be found here. Let's take a look at this repository's lifecycle:

  1. We begin our journey at the master branch. This is where the project's website pulls the content from. That is, the project we show the world resides in the master branch of the related repository. If you take a look at the sample repo we linked above you'll see how each translation resides in a folder labelled with the translation's language. This branch is the one Crowdin pulls its content too. We mustn't forget the English project is already "done"; it's the final version. That's why Crowdin pulls the en directory from the master branch and that's what's offered to translators and reviewers to work on.

  2. Once a translation is finished, Crowdin will push the content to the l10n_master branch of the original repository. Each language is added as a new repository with a 4-letter local code (just like the ones you can see in the master branch) as the directory's name. A Korean translation would be contained in the ko-KR folder for instance.

  3. Maja and Nina will go over the files from the l10n_master branch and clean them up. They'll then push them to the draft branch and build a draft version of the project which they check for errors. Once everything is looking fine they merge the draft branch into the master one and the project is now live because, as seen in step 1, master is where the live website pulls content from.

If we take a closer look at the workflow we'll see that what Nina and Maja are doing with the files is:

  1. They take the translated language folder out of the l10n_master branch and run it through nttt.

  2. They open the files to manually clean up the remaining mistakes nttt can't fix. This is where we should focus on helping because if we make nttt handle all the incorrect formatting we can free up Nina and Maja and make the publishing process that much faster.

  3. The push the cleaned files to draft and take a look at the draft version to make sure everything is looking good.

  4. They end up pushing everything to master and the project is now live!

Clone this wiki locally