Ian Y. Choi f65156b724 Explains Zuul tasks and fixes when Zanata syncs

This patch describes Zuul instead of Jenkins since translation
jobs are also migrated to Zuul v3.

Let's clarify by using terms as follows:
 - Tasks are for Ansible playbooks as yaml tasks
 - Scripts are actual shell scripts called from tasks

Also, while syncs to project repositories are periodic jobs,
syncs to Zanata are post jobs which execute after patches on
repositories are merged.

Change-Id: Iefa50e396d3eb9f016fb17999e2c88b8457e4ea4

2018-01-25 14:52:55 +00:00

4.7 KiB

Raw Blame History

Translation infrastructure

A series of tasks in OpenStack infrastructure is used to manage translation changes in Zanata. Without running the tasks, translation changes will not be reflected into OpenStack projects. This page explains how the infrastructure tasks run actual scripts as Zuul jobs and monitor the job status.

Translation jobs

We have two types of Zuul jobs for translations: syncing source strings into Zanata with the latest repositories and pushing translations from Zanata into the repositories. The first job is for Zanata-side updates. Up-to-date source strings to be translated are compared and updated between OpenStack project repositories and Zanata. If source texts in OpenStack project repositories are changed, then change sets are pushed into Zanata so translaters deal with up-to-date source strings. On the other hand, the second job is aimed to reflect changes in translated strings in Zanata (after translators do translation activities) into corresponding OpenStack project repositories. The job will propose changes as Translation Import <reviewing-translation-import> Gerrit patches.

Update jobs for Zanata start after patches are merged on OpenStack project repositories, and Zuul starts to run tasks everyday at 6:00 UTC for the updates on OpenStack project repositories.

Note that not all translation changes are the target for translation jobs. The goal is to have consistent translated programs, UIs, and documentation. There is not much sense if only a few lines are translated. The team has decided that files that have at least 75 percent of messages translated will be in the git repositories.

To not have too much churn and last minute string fixes lead to files get removed, there is also a lower threshold for releases of 66 percent of messages translated as policy - which is only manually enforced.

The OpenStack infra scripts excuted by tasks currently download new files that are at least 75 percent translated and if files grow over time but do not get new translations (or strings change too much), they will be removed again automatically from the project with a lower threshold of currently 40 percent.

Monitoring translation jobs status

OpenStack Health dashboard provides us a convenient way to check the translation job status.