Commit 7ef5fbf4 authored by Heather Ellsworth's avatar Heather Ellsworth

Add instructions for translations

Fixes #58
parent d0d6f2eb
......@@ -3,6 +3,11 @@
Contributing
============
.. toctree::
:hidden:
Contributing/Translations
We welcome merge requests and issues being filed in our code repositories. Typically, issues get filed under the project that the issue relates to and you can browse our `list of projects <https://source.puri.sm/Librem5/>`_. For example, if you find an issue with the documentation, you can file an issue under the `developer docs <https://source.puri.sm/Librem5/developer.puri.sm/issues>`_ project. An issue can be any mistake you found in the project, e.g. a crash, a bug, or even a typo. You are welcome to file an issue when you want to make us aware of some important topic relating to the project as well.
Aside from project specific issues, we do have an `Apps_issues <https://source.puri.sm/Librem5/Apps_Issues>`_ project to track tasks like applications to port to the phone or issues with them. Here you can add a task for a particular app to be ported to the phone. However, be sure to search our `list of projects <https://source.puri.sm/Librem5/>`_ first before opening an issue under `Apps_issues <https://source.puri.sm/Librem5/Apps_Issues>`_.
......
.. _translations:
Translations
============
A common way of contributing is by adding translations to our various projects. The translations are contributed via a public `Zanata server <https://translate.zanata.org/>`_. If you are interested in contributing a tranlsation, here is the process:
Create an account
^^^^^^^^^^^^^^^^^
The public zanata server requires you to first create an account with them. Once you have done this, log in and you will be taken to your dashboard.
Join a language team
^^^^^^^^^^^^^^^^^^^^
In order to have write access to a certain language, you will first need to join the corresponding language team. On your dashboard, you should see the "Join a language team" link where you can search for and join a specific team.
Find our projects
^^^^^^^^^^^^^^^^^
Once you're a part of a language team, click the "Explore" icon on the left panel to search for our projects. For example, you can search for "phosh" and you should find our phosh project. The page for the project should list versions so click the latest version listed to access the list of languages available for translation.
.. image:: phosh-project-page.png
:width: 700px
:height: 200px
:align: center
Add a translation
^^^^^^^^^^^^^^^^^
Select the language for which you wish to add a translation (under the Languages column) and then select the project name (under the Documents column).
.. image:: phosh-get-to-translation.png
:width: 700px
:height: 200px
:align: center
Now you should have the tranlation page displayedn where you can see the English text on the left half of the screen and add a translation to the right half of the screen (with suggestions on the bottom part of the screen).
.. image:: phosh-translate-page.png
:width: 700px
:height: 300px
:align: center
Note that if you are not part of the corresponding language team (or an admin for the project), then you will not be able to enter text for translating these fields.
What's next?
^^^^^^^^^^^^
Every time the Librem 5 team releases a new version of the project, the new translations will be grabbed from Zanata. By adding a translation in Zanata, you are creating a .po file that will get picked up in the next release of the project.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment