Skip to content

Commit

Permalink
minor #5744 translations have been removed from symfony.com (xabbuh)
Browse files Browse the repository at this point in the history
This PR was merged into the 2.3 branch.

Discussion
----------

translations have been removed from symfony.com

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets | #4078

The old page will be kept for people following a deep link or a bookmark, but the actual content has been removed and is replaced with a link to [the blog article](http://symfony.com/blog/discontinuing-the-symfony-community-translations).

Commits
-------

b2e78a6 translations have been removed from symfony.com
  • Loading branch information
xabbuh committed Oct 9, 2015
2 parents 63f44e3 + b2e78a6 commit 87b7e3d
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 90 deletions.
6 changes: 5 additions & 1 deletion contributing/documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,9 @@ Contributing Documentation
overview
format
standards
translations
license

.. toctree::
:hidden:

translations
5 changes: 0 additions & 5 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,11 +299,6 @@ Please be patient. It can take up to several days before your pull request can
be fully reviewed. After merging the changes, it could take again several hours
before your changes appear on the symfony.com website.

What If I Want to Translate Some Documentation into my Language?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Read the dedicated :doc:`document </contributing/documentation/translations>`.

Why Should I Use the Oldest Maintained Branch Instead of the Master Branch?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
86 changes: 3 additions & 83 deletions contributing/documentation/translations.rst
Original file line number Diff line number Diff line change
@@ -1,87 +1,7 @@
Translations
============

The Symfony documentation is written in English and many people are involved
in the translation process.
The Symfony documentation is not officially translated, though some community
groups still maintain some translations. For more information, see `this blog post`_.

.. note::

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.

Contributing
------------

First, become familiar with the :doc:`markup language </contributing/documentation/format>`
used by the documentation.

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

.. note::

If you want to contribute translations for a new language, read the
:ref:`dedicated section <translations-adding-a-new-language>`.

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:

* *(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.

.. _translations-adding-a-new-language:

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, 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 ``index.rst`` and ``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).

Maintenance
-----------

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.

.. caution::

Non maintained languages are removed from the official list of
repositories as obsolete documentation is dangerous.

.. _`an ongoing discussion`: https://github.com/symfony/symfony-docs/issues/4078
.. _`this blog post`: http://symfony.com/blog/discontinuing-the-symfony-community-translations
1 change: 0 additions & 1 deletion contributing/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
* :doc:`Overview </contributing/documentation/overview>`
* :doc:`Format </contributing/documentation/format>`
* :doc:`Documentation Standards </contributing/documentation/standards>`
* :doc:`Translations </contributing/documentation/translations>`
* :doc:`License </contributing/documentation/license>`

* **Community**
Expand Down

0 comments on commit 87b7e3d

Please sign in to comment.