The Symfony documentation is written in English and many people are involved in the translation process.
Symfony Project officially discourages from starting new translations for the documentation. As a matter of fact, there is an ongoing discussion in the community about the benefits and drawbacks of community driven translations.
First, become familiar with the markup language used by the documentation.
Then, subscribe to the Symfony docs mailing-list, as collaboration happens there.
Finally, find the master repository for the language you want to contribute for. Here is the list of the official master repositories:
- English: https://github.com/symfony/symfony-docs
- French: https://github.com/symfony-fr/symfony-docs-fr
- Italian: https://github.com/garak/symfony-docs-it
- Japanese: https://github.com/symfony-japan/symfony-docs-ja
- Portuguese (Brazilian): https://github.com/andreia/symfony-docs-pt-BR
If you want to contribute translations for a new language, read the dedicated section.
Joining the Translation Team¶
If you want to help translating some documents for your language or fix some bugs, consider joining us; it's a very easy process:
- Introduce yourself on the Symfony docs mailing-list;
- (optional) Ask which documents you can work on;
- Fork the master repository for your language (click the "Fork" button on the GitHub page);
- Translate some documents;
- Ask for a pull request (click on the "Pull Request" from your page on GitHub);
- The team manager accepts your modifications and merges them into the master repository;
- The documentation website is updated every other night from the master repository.
Adding a new Language¶
This section gives some guidelines for starting the translation of the Symfony documentation for a new language.
As starting a translation is a lot of work, talk about your plan on the Symfony docs mailing-list and try to find motivated people willing to help.
When the team is ready, nominate a team manager; they will be responsible for the master repository.
Create the repository and copy the English documents.
The team can now start the translation process.
When the team is confident that the repository is in a consistent and stable
state (everything is translated, or non-translated documents have been removed
from the toctrees -- files named
map.rst.inc), the team
manager can ask that the repository is added to the list of official master
repositories by sending an email to Fabien (fabien at symfony.com).
Translation does not end when everything is translated. The documentation is a moving target (new documents are added, bugs are fixed, paragraphs are reorganized, ...). The translation team need to closely follow the English repository and apply changes to the translated documents as soon as possible.
Non maintained languages are removed from the official list of repositories as obsolete documentation is dangerous.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.