summaryrefslogtreecommitdiffstats
path: root/wiki/src/blueprint/translation_platform.mdwn
diff options
context:
space:
mode:
authorUlrike Uhlig <u@451f.org>2018-04-06 12:53:28 +0200
committerUlrike Uhlig <u@451f.org>2018-04-06 12:53:28 +0200
commit0843dee2a7495bdbee45e9499a15dc719c21f903 (patch)
tree8d29576898f69e89395f23533490b5f7d7803c13 /wiki/src/blueprint/translation_platform.mdwn
parentf26b12f78de2490bfe3eedc98a26255b52d56cf7 (diff)
Start updating the blueprint with more up-to-date information.
Diffstat (limited to 'wiki/src/blueprint/translation_platform.mdwn')
-rw-r--r--wiki/src/blueprint/translation_platform.mdwn84
1 files changed, 61 insertions, 23 deletions
diff --git a/wiki/src/blueprint/translation_platform.mdwn b/wiki/src/blueprint/translation_platform.mdwn
index 5c5bf7b..d15663d 100644
--- a/wiki/src/blueprint/translation_platform.mdwn
+++ b/wiki/src/blueprint/translation_platform.mdwn
@@ -4,12 +4,18 @@
Our (website) translation infrastructure has a pretty high barrier for
new translators, especially those who are not familiar with Git and/or
the command line.
-Furthermore, the current process makes it hard to add new languages, as often a team cannot be built easily over a long period of time and a web interface could nevertheless help keep translations until a new person arrives.
+Furthermore, the current process makes it hard to add new languages, as
+often a team cannot be built easily over a long period of time and a web
+interface could nevertheless help keep translations until a new person
+arrives.
-Corresponding ticket: [[!tails_ticket 9049]]
+Corresponding ticket: [[!tails_ticket 10034]]
+
+Choosing a translation web platform
+===================================
MUST
-====
+----
* provide a usable easy web interface
* be usable from Tor Browser
@@ -22,7 +28,7 @@ MUST
* provide user roles (admin, reviewer, translator)
SHOULD
-======
+------
* be "privacy sensitive", i.e. be operated by a non-profit
* allow translators to push translations through Git (so that core
@@ -34,7 +40,7 @@ SHOULD
* provide feature to write/read comments between translators
MAY
-===
+---
* allow translating topic branches without confusing translators,
causing duplicate/premature work, fragmentation or merge conflicts
@@ -54,12 +60,27 @@ MAY
If we don't have that, then [[contribute/how/translate]] MUST
document how to report issues in the original English text.
-Weblate setup
-=============
+Setup of our translation platform & integration with our infrastructure
+=======================================================================
+
+Documentation
+-------------
+
+We have two documentations:
+- this one, which presents the current status of our work and all public
+ information
+- translate-server.git which contains more technical information,
+ cronjobs, configs, inner workings of the setup.
+
+Translation web interface
+-------------------------
-We are testing a [weblate instance](https://translate.tails.boum.org/) to see if it fits our requirements. Read [[!tails_ticket 11759]] for more information.
+We are testing a [Weblate instance](https://translate.tails.boum.org/)
+to see if it fits our requirements. Read [[!tails_ticket 11759]] for
+more information.
-There are several languages enabled and users can suggest translations in several languages:
+There are several languages enabled and users can suggest translations
+in several languages:
<a href="http://translate.tails.boum.org/engage/tails/?utm_source=widget">
<img src="http://translate.tails.boum.org/widgets/tails/-/multi-red.svg" alt="Translation status" />
@@ -67,14 +88,19 @@ There are several languages enabled and users can suggest translations in severa
What we plan to do is:
-[Schematics of the different Git repos, ikiwiki instances, and their relationships.](https://labs.riseup.net/code/attachments/download/1551/weblate.svg)
+[Schematics of the different Git repos, ikiwiki instances, and their relationships.](https://labs.riseup.net/code/attachments/download/1922/weblate.svg)
+
+[Schematics of the infrastructure such as Git hooks.](https://labs.riseup.net/code/attachments/download/1928/weblate_hooks.svg)
Repository
----------
-Currently the repo is following Tails master repo, but the changes generated in translate.lizard are not fed back onto Tails master automatically.
+Currently the repository used by Weblate is built upon the Tails master
+repo, but the changes generated in translate.lizard are not fed back
+onto Tails master automatically.
-There are several languages enabled, some of them with few or not translations.
+There are several languages enabled, some of them with few or not
+translations.
You can check out weblate-generated Tails repo with:
@@ -82,14 +108,19 @@ You can check out weblate-generated Tails repo with:
This Tails repository has two main differences with other repos:
-- The ikiwiki.setup file has been changed to build more languages
-- There is a .gitlab.yml file to trigger tests when pushed to gitlab CI enabled repositories
-- There are lots of new language files
+- The ikiwiki.setup file has been changed to build more languages.
+ → Ideally, we would create ikiwiki-translationplatform.setup
+- There is a .gitlab.yml file to trigger tests when pushed to gitlab CI
+ enabled repositories. → We can either add this file to tails/master or
+ document this only for people who use gitlab.
+- There are new language files from currently non-active languages on
+ the main website.
Reviewing translation platform output
-------------------------------------
-For languages like fr, fa, de, or it that are part of tails master repo, you can get the files to review and submit to tails-l10n:
+For languages like fr, fa, de, and it - that are part of tails master repo -
+you can get the files to review and submit to tails-l10n:
git remote add translations https://translate.tails.boum.org/git/tails/index/
git checkout tails/master
@@ -98,19 +129,26 @@ For languages like fr, fa, de, or it that are part of tails master repo, you can
And you will have all the changes to farsi (*.fa.po) to review. The same goes for the other languages.
-Staging version
+Staging website
---------------
-From this repository, a version of the website with more languages will be built [[!tails_ticket 12311]] so users can see how the file they are translating looks.
+From this (or a modified clone of this) repository, a version of the
+website with more languages will be built [[!tails_ticket 15077]] so
+that users can see how the file they are translating looks.
Updating the repo
-----------------
-PO files for enabled languages are built from the mdwn files when [[building the wiki|contribute/build/]].
-
-This process is currently done outside of the weblate instance, and merged onto weblate repo by hand. As translate.lizard has so many languages, if there are many changes this process can take a while.
+POT, then PO files for enabled languages are built and updated from the
+*.mdwn files when [[building the wiki|contribute/build/]].
-The machine currently doing this work can also provide a staging website, as it is the result of the building of the wiki anyway.
+This process is currently done outside of the Weblate instance, and
+merged onto the Weblate repo by hand. As translate.lizard has so many
+languages, if there are many changes this process can take a while.
The changes generated [[while building the wiki|contribute/build/]]
-can be fed back to weblate by cherry picking.
+can be fed back to Weblate by cherry picking.
+
+On the long term, we will automate this process by
+- pulling automatically from tails/master and applying a merge strategy
+ for po [[!tails_ticket ]]