Merge pull request #1679 from wallabag/v2-translation-doc

Documentation about translation

3 files changed, 40 insertions, 5 deletions

diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst
index 9ed9dde2..aece2984 100644
--- a/docs/en/developer/docker.rst
+++ b/docs/en/developer/docker.rst
@@ -1,4 +1,4 @@
-Run Wallabag in docker-compose
+Run wallabag in docker-compose
 ==============================
 
 In order to run your own development instance of wallabag, you may
@@ -15,8 +15,8 @@ your system and up to date.
 Switch DBMS
 -----------
 
-By default, Wallabag will start with a sqlite database.
-Since Wallabag provide support for Postgresql and MySQL, docker
+By default, wallabag will start with a sqlite database.
+Since wallabag provides support for Postgresql and MySQL, docker
 containers are also available for these ones.
 
 In ``docker-compose.yml``, for the chosen DBMS uncomment :
@@ -33,7 +33,7 @@ In order to keep running Symfony commands on your host (such as
   like ``SYMFONY__ENV__DATABASE_HOST`` will exist.
 - create a ``127.0.0.1 rdbms`` on your system ``hosts`` file
 
-Run Wallabag
+Run wallabag
 ------------
 
 #. Fork and clone the project
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst
new file mode 100644
index 00000000..ff2b8f0e
--- /dev/null
+++ b/docs/en/developer/translate.rst
@@ -0,0 +1,34 @@
+Translate wallabag
+==================
+
+Translation files
+-----------------
+
+You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.
+
+You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE is the the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).
+
+There is still one file to translate: https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations.
+
+You have to create ``CraueConfigBundle.CODE.yml``.
+
+Configuration file
+------------------
+
+You have to edit `app/config/config.yml
+<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ to display your language on Configuration page of wallabag (to allow users to switch to this new translation).
+
+Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example
+
+::
+
+    wallabag_core:
+        ...
+        languages:
+            en: 'English'
+            fr: 'Français'
+
+
+For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above).
+
+For the second column, it's the name of your language. Just that.
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 7dd01b39..acd9b383 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -34,4 +34,5 @@ The main documentation for this application is organized into a couple sections:
    :maxdepth: 2
    :caption: Developer documentation
 
-   developer/docker
\ No newline at end of file
+   developer/docker
+   developer/translate