diff options
-rw-r--r-- | docs/en/developer/docker.rst | 8 | ||||
-rw-r--r-- | docs/en/developer/translate.rst | 34 | ||||
-rw-r--r-- | docs/en/index.rst | 3 |
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 @@ | |||
1 | Run Wallabag in docker-compose | 1 | Run wallabag in docker-compose |
2 | ============================== | 2 | ============================== |
3 | 3 | ||
4 | In order to run your own development instance of wallabag, you may | 4 | In order to run your own development instance of wallabag, you may |
@@ -15,8 +15,8 @@ your system and up to date. | |||
15 | Switch DBMS | 15 | Switch DBMS |
16 | ----------- | 16 | ----------- |
17 | 17 | ||
18 | By default, Wallabag will start with a sqlite database. | 18 | By default, wallabag will start with a sqlite database. |
19 | Since Wallabag provide support for Postgresql and MySQL, docker | 19 | Since wallabag provides support for Postgresql and MySQL, docker |
20 | containers are also available for these ones. | 20 | containers are also available for these ones. |
21 | 21 | ||
22 | In ``docker-compose.yml``, for the chosen DBMS uncomment : | 22 | 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 | |||
33 | like ``SYMFONY__ENV__DATABASE_HOST`` will exist. | 33 | like ``SYMFONY__ENV__DATABASE_HOST`` will exist. |
34 | - create a ``127.0.0.1 rdbms`` on your system ``hosts`` file | 34 | - create a ``127.0.0.1 rdbms`` on your system ``hosts`` file |
35 | 35 | ||
36 | Run Wallabag | 36 | Run wallabag |
37 | ------------ | 37 | ------------ |
38 | 38 | ||
39 | #. Fork and clone the project | 39 | #. 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 @@ | |||
1 | Translate wallabag | ||
2 | ================== | ||
3 | |||
4 | Translation files | ||
5 | ----------------- | ||
6 | |||
7 | You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. | ||
8 | |||
9 | 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>`__). | ||
10 | |||
11 | There is still one file to translate: https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations. | ||
12 | |||
13 | You have to create ``CraueConfigBundle.CODE.yml``. | ||
14 | |||
15 | Configuration file | ||
16 | ------------------ | ||
17 | |||
18 | You have to edit `app/config/config.yml | ||
19 | <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). | ||
20 | |||
21 | Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example | ||
22 | |||
23 | :: | ||
24 | |||
25 | wallabag_core: | ||
26 | ... | ||
27 | languages: | ||
28 | en: 'English' | ||
29 | fr: 'Français' | ||
30 | |||
31 | |||
32 | For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above). | ||
33 | |||
34 | 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: | |||
34 | :maxdepth: 2 | 34 | :maxdepth: 2 |
35 | :caption: Developer documentation | 35 | :caption: Developer documentation |
36 | 36 | ||
37 | developer/docker \ No newline at end of file | 37 | developer/docker |
38 | developer/translate | ||