|
1 | 1 | Translations |
2 | 2 | ============ |
3 | 3 |
|
4 | | -The Symfony documentation is written in English and many people are involved |
5 | | -in the translation process. |
| 4 | +The Symfony documentation is not officially translated, though some community |
| 5 | +groups still maintain some translations. For more information, see `this blog post`_. |
6 | 6 |
|
7 | | -.. note:: |
8 | | - |
9 | | - Symfony Project officially discourages from starting new translations for the |
10 | | - documentation. As a matter of fact, there is `an ongoing discussion`_ in |
11 | | - the community about the benefits and drawbacks of community driven translations. |
12 | | - |
13 | | -Contributing |
14 | | ------------- |
15 | | - |
16 | | -First, become familiar with the :doc:`markup language </contributing/documentation/format>` |
17 | | -used by the documentation. |
18 | | - |
19 | | -Finally, find the *master* repository for the language you want to contribute |
20 | | -for. Here is the list of the official *master* repositories: |
21 | | - |
22 | | -* *English*: https://github.com/symfony/symfony-docs |
23 | | -* *French*: https://github.com/symfony-fr/symfony-docs-fr |
24 | | -* *Italian*: https://github.com/garak/symfony-docs-it |
25 | | -* *Japanese*: https://github.com/symfony-japan/symfony-docs-ja |
26 | | -* *Portuguese (Brazilian)*: https://github.com/andreia/symfony-docs-pt-BR |
27 | | - |
28 | | -.. note:: |
29 | | - |
30 | | - If you want to contribute translations for a new language, read the |
31 | | - :ref:`dedicated section <translations-adding-a-new-language>`. |
32 | | - |
33 | | -Joining the Translation Team |
34 | | ----------------------------- |
35 | | - |
36 | | -If you want to help translating some documents for your language or fix some |
37 | | -bugs, consider joining us; it's a very easy process: |
38 | | - |
39 | | -* *(optional)* Ask which documents you can work on; |
40 | | -* Fork the *master* repository for your language (click the "Fork" button on |
41 | | - the GitHub page); |
42 | | -* Translate some documents; |
43 | | -* Ask for a pull request (click on the "Pull Request" from your page on |
44 | | - GitHub); |
45 | | -* The team manager accepts your modifications and merges them into the master |
46 | | - repository; |
47 | | -* The documentation website is updated every other night from the master |
48 | | - repository. |
49 | | - |
50 | | -.. _translations-adding-a-new-language: |
51 | | - |
52 | | -Adding a new Language |
53 | | ---------------------- |
54 | | - |
55 | | -This section gives some guidelines for starting the translation of the |
56 | | -Symfony documentation for a new language. |
57 | | - |
58 | | -As starting a translation is a lot of work, try to find motivated people |
59 | | -willing to help. |
60 | | - |
61 | | -When the team is ready, nominate a team manager; they will be responsible for |
62 | | -the *master* repository. |
63 | | - |
64 | | -Create the repository and copy the *English* documents. |
65 | | - |
66 | | -The team can now start the translation process. |
67 | | - |
68 | | -When the team is confident that the repository is in a consistent and stable |
69 | | -state (everything is translated, or non-translated documents have been removed |
70 | | -from the toctrees -- files named ``index.rst`` and ``map.rst.inc``), the team |
71 | | -manager can ask that the repository is added to the list of official *master* |
72 | | -repositories by sending an email to Fabien (fabien at symfony.com). |
73 | | - |
74 | | -Maintenance |
75 | | ------------ |
76 | | - |
77 | | -Translation does not end when everything is translated. The documentation is a |
78 | | -moving target (new documents are added, bugs are fixed, paragraphs are |
79 | | -reorganized, ...). The translation team need to closely follow the English |
80 | | -repository and apply changes to the translated documents as soon as possible. |
81 | | - |
82 | | -.. caution:: |
83 | | - |
84 | | - Non maintained languages are removed from the official list of |
85 | | - repositories as obsolete documentation is dangerous. |
86 | | - |
87 | | -.. _`an ongoing discussion`: https://github.com/symfony/symfony-docs/issues/4078 |
| 7 | +.. _`this blog post`: http://symfony.com/blog/discontinuing-the-symfony-community-translations |
0 commit comments