Set guidelines for contributing translations of documentation

Pylons / pyramid

Pyramid - A Python web framework

https://trypyramid.com/

Other

3.97k stars 886 forks source link

Set guidelines for contributing translations of documentation #2105

Open stevepiercy opened 9 years ago

stevepiercy commented 9 years ago

How should translations be done for Pyramid?

This thread on pylons-discuss has some ideas https://groups.google.com/forum/#!searchin/pylons-discuss/portuguese/pylons-discuss/qqFDOMpHsJ4/CJpZnQng-o4J
Read the Docs has guidelines for translations.
Transifex is a platform for collaborating on translations to spread the workload. It is free for open source projects that have an OSI approved license.
Plone uses Transifex.
Plone has guidelines for translations.
Plone has a mailing list for i18n.
We could use Google Translate for websites buttons.
A very good video from PyCon 2015 on the topic: I18N: World Domination the Easy Way.

marioidival commented 9 years ago

Great @stevepiercy o/

winstonf88 commented 9 years ago

I think this can help http://sphinx-doc.org/latest/intl.html

winstonf88 commented 8 years ago

I have finished pt_BR translations for the index and Quick Tour. It would be helpful to know how translations should be done before doing any more work.

marioidival commented 8 years ago

@winstonf88 muito bom man :)

stevepiercy commented 8 years ago

@winstonf88 I've never done translations before. Let's figure it out together! :grin:

Out of the above listed items, the Read the Docs item is a requirement. Here are the steps:

Make a new project named pyramid-pt-br under your GitHub username.
Commit your translations to the project.
Create a RTD account and import your project into RTD.
On RTD, configure your project so that it builds the docs on RTD.
Configure your GitHub repo with a webhook to automatically build the docs on RTD.

When I want to see how RTD builds the Pyramid documentation without affecting the "official" docs, I can view the built docs of my fork of Pyramid. Pretty cool, huh?

So once you get that setup, and assuming everything builds properly, we will import your project under the Pylons Project, and make it an "official" translation of Pyramid documentation.

Did you look into any other of the listed items above, like Transifex?

winstonf88 commented 8 years ago

@stevepiercy I created the project on RTD and everything is setup.

Github: https://github.com/winstonf88/pyramid-pt-br.git RTD: http://pyramid-pt-br.readthedocs.org / pyramid-pt-br.rtfd.org

I took a quick look at the links, but didn't quite understand how to integrate them. I will take a better look into it as soon as I have some time.

stevepiercy commented 8 years ago

Thank you @winstonf88. This is a good start. I think the next steps include following the model set by Plone, so we can easily spread the workload through Transifex for any translation. We've had requests for Spanish, Russian, and Japanese, too.

stevepiercy commented 7 years ago

FTR, I took a step forward for translations in #2838. As narrative docs are updated, this should make translations vastly easier for translators.