A community-maintained Python framework for creating mathematical animations.
Finalized translation process and documentation (#2313)
Mysaa95d30d2d4fbd
diff --git a/docs/source/contributing/internationalization.rst b/docs/source/contributing/internationalization.rstindex e5f5e6f7d..dbb5b3f53 100644--- a/docs/source/contributing/internationalization.rst+++ b/docs/source/contributing/internationalization.rst@@ -2,52 +2,89 @@Internationalization====================-.. note::- The translation process is currently not yet ready. Please avoid translating pages for now.+Thank you for your interest in localizing Manim! Please read the+instructions below to get started. You are also encouraged, though not+required, to join our `Discord+server <https://manim.community/discord>`__.-If you want to help with translating the docs:+Signing up+==========-#. Make sure you have a `Transifex <https://www.transifex.com/>`_ account. Transifex is a tool for colaborative translation and allows the Manim team to review translations.-#. Open the `Manim Transifex project page <https://www.transifex.com/manim-community/manim-community-documentation>`_ .-#. Click on ``Join Team``.-#. Select the language you want to help with.+You will first need to create an account for our project. Go to our+`project homepage <https://translate.manim.community/>`__ and click the+sign up button at the top right hand corner. Follow the instructions to+create an account. After creating an account, you should return back to+our homepage. Click the Manim project to contribute translations for the+main library.-Congratulations! You are now a Translator for the Manim project!+Contributing+============+Voting+-------You'll see the projects you've joined just on the left of your profile picture-on the top bar.+To ensure that our translations are of good quality, we use+crowdsourcing and voting to approve good translations and reject bad+ones. The current threshold for a translation being accepted is 3 votes;+this may change as we gauge the level of activity in the community and+the quality of translations.-.. image:: /_static/select_transifex_repo.png- :align: center- :width: 200+To vote on translations, first click on a language you would like to+help with, then click the "translate all" button. You should then enter+the translation editor. Next to the search bar, you will see a+funnel-like icon - click it and select the "Need to Be Voted" option to+see translations that need to be voted on. You can then select a string+on the left sidebar, view the translations at the bottom and vote with+the + and - icons for good and poor translations respectively.-Now go to the-`languages list <https://www.transifex.com/manim-community/manim-community-documentation/languages/>`_-and select a language you want to help with. You should see a blue button reading-`Translate`; click on it to get started! You will see a list of-resources in the project. You can click on any untranslated resource, then-click on `Translate`. You will then see something like the following:+Translations+-------------.. image:: /_static/transifex_explanation.png- :align: center+You can also help with contributing translations directly. Follow the+steps above to enter the translation editor (instead of clicking+"Translate all", you may also choose to translate strings from a+specific file by clicking them). Crowdin's on-screen tutorial should+guide you through the process.-The `A` panel is the list of all the strings in the resource. Click on any of-them to translate it. It will appear in the `B` panel, and you will be able to-work on your translation in the `C` panel. Once you're done, click `Save changes`.-Your translation will have to be reviewed before being added to the docs.-You can also get back to the resources list by clicking `d` or change the-destination language in `e`.+Translation guidelines+======================+In general, follow the conventions for technical writing in your target+language. You may want to refer to similar, high quality sources (eg.+Python's documentation in your language) for guidance. Note that code+blocks, code literals, names and pseudonyms should be left unchanged.-If you want to become a reviewer, please join `Manim's Discord server <https://www.manim.community/discord/>`_-and ping the role @Translation Admin.+Proofreading+============-If you want to add a new language, you can go to-`the project page <https://www.transifex.com/manim-community/manim-community-documentation>`_-If you haven't joined the project yet, you will have a link which reads-`Request language` which you can click.-If you are already in the project, this button will be in the languages page.+For certain languages with a significant number of speakers within the+Manim Community, an additional step of proofreading is used after+crowdsourcing to further ensure the quality of our translations.+Proofreaders are trusted community members who will look over and give+the final approval on translations. If you would like to be a+proofreader, please email [email protected] with the answers+to the following questions:-We will have to manually accept the new language, so you will not be able to-translate instantaneously (for new languages).+1. What is your Crowdin username?+2. What is your Discord username (optional)?+3. What is your GitHub username (optional)?+4. List the languages you speak, and your level of fluency with them.+5. What language(s) are you applying to be a proofreader for?+6. Do you have any previous experience with translations?+7. If yes, give us more details.+8. How will you ensure the quality of translations, should you become a+ proofreader?++Please note that you don't need to have prior translation experience to+be a proofreader, just a commitment to maintaining a good quality of+translations.++Errors+======++Source errors+-------------++If you spot an error with a source string, report it to us by opening an+`issue <https://github.com/ManimCommunity/manim/issues/new/choose>`__ on+GitHub. Refrain from translating the string until the issue is resolved.