scrapy / scrapy

Scrapy, a fast high-level web crawling & scraping framework for Python.
https://scrapy.org
BSD 3-Clause "New" or "Revised" License
52.74k stars 10.51k forks source link

Translating the docs #3511

Open Maransatto opened 5 years ago

Maransatto commented 5 years ago

Hi folks,

I've been talking to @lopuhin and we have decide to start a translation project for the docs to Portuguese so that we can increase the community here in Brazil.

At first he suggested me using the RTD itself (Read the docs), and he's also considering using transifex (https://www.transifex.com ).

I've read a little about both scenarios and I think we could start by creating multiple languages with ReadtheDocs once this is the first localization project. https://docs.readthedocs.io/en/latest/localization.html

Well, I'd like to know your opinion.

Right now I'm forking the project to my own github account to start to understand how it works (RTD). https://github.com/Maransatto/scrapy

I don't actually know how to merge it from my project to this one, or... if the admins here decide to give me some permission I can create a branch for this.

Obs: I also have 3 friends here in Brazil that will help me to make the translation.

Maransatto commented 5 years ago

There's something else, I didn't get the idea of how I'm supposed to to here to manage multiple translations. Should it be docs-portuguese?

https://docs.readthedocs.io/en/latest/localization.html

Maransatto commented 5 years ago

Well, After reading a little bit more of the documentation, I got the idea of Transifex. I Think we can use it.

For now I'm going to create the necessary structure with the .po files: https://docs.readthedocs.io/en/latest/guides/manage-translations.html?highlight=translation

Edit: The things can be made in parallel.

lopuhin commented 5 years ago

Thanks for moving this forward @Maransatto 👍

I also checked out https://www.transifex.com/ and found https://www.transifex.com/excript/scrapy/ with some progress in Portuguese (Brazil) and https://www.transifex.com/pptt/scrapy-docs/ with some progress in Chinese - I requested joining both of them, but the projects don't look active, so maybe we need to create another. Here is the open source guide: https://docs.transifex.com/projects/open-source-project

Here is also the Django translation repo for reference: https://github.com/django/django-docs-translations

lopuhin commented 5 years ago

@Maransatto I created the project https://www.transifex.com/scrapy-translation-team/scrapy-docs-translation/ but didn't upload anything for translation yet, I'll add you as a collaborator - I think you need to request to join the project for that.

ficosta commented 5 years ago

@lopuhin Hi, I sent a request to join. I would like to contribute too.

Maransatto commented 5 years ago

@ficosta I've forked the project to github.com/maransatto/scrapy To be honest I don't know how to request to join here, I thought we would have access to a new branch here. (I'm used to gitlab instead of github)

Should we use our fork or the official as a remote server? If we use here, how to become a contributor?

Anyways, Now I'm going to check how to use Transifex.

Lucas-Palomo commented 5 years ago

@Maransatto Congratulations by this initiative, certainly this will assist all programmers from Brazil.

lopuhin commented 5 years ago

Hi all, I manually uploaded README.po from @Maransatto 's https://github.com/Maransatto/scrapy/tree/docs-to-portuguese/docs/locales/pt_BR/LC_MESSAGES to https://www.transifex.com/scrapy-translation-team/scrapy-docs-translation/ and created one dummy translation, the UI looks nice. I can invite collaborators now, but I don't see any pending requests in transifex UI (perhaps I'm missing them). I can add collaborators and maintainers by username or email though.

@Maransatto @ficosta could you please give usernames or emails which you used to register, and I'll add you to the transifex project. Feel free to send this info via email (link in my profile) or via #scrapy IRC (I'm kostia there).

lopuhin commented 5 years ago

On a related theme, as noted by @lucywang000, there is a Chinese translation repo of scrapy-docs on github: https://github.com/marchtea/scrapy_doc_chs but it's outdated (the latest is 1.0), and deployed to https://scrapy-chs.readthedocs.io/zh_CN/1.0/

luisandia commented 5 years ago

@lopuhin Hi, I'd like to translate scrapy docs to spanish, Can you add me to transifex project?

lopuhin commented 5 years ago

@luisandia thanks for your help, just added you and your colleges, I hope this gives enough permissions to upload po files and to translate.

christianfm10 commented 5 years ago

Hi all, I manually uploaded README.po from @Maransatto 's https://github.com/Maransatto/scrapy/tree/docs-to-portuguese/docs/locales/pt_BR/LC_MESSAGES to https://www.transifex.com/scrapy-translation-team/scrapy-docs-translation/.

@lopuhin Hi, I think it's better to change the files (.rst) to simple text files (.txt) by changing the extension and upload them to Transifex. After finishing the translations, you can download them again as .txt and then change the extension to .rst without losing any information.

Edit: For more information: https://github.com/transifex/transifex-client/issues/230

lopuhin commented 5 years ago

@christianfm10 thanks! To clarify what you mean, do you suggest to upload .txt files instead of uploading .po files?

denzow commented 5 years ago

@lopuhin Hi, I'd like to translate scrapy docs to Japanese. Some part of docs are traslated in japanese by my colleague. I wanna upload them. Could you add me to transifex project and add Japanese language?

lopuhin commented 5 years ago

@denzow this is great, thanks for you help! Can you register on transifex and tell me the email address (or make a request for new language there)?

denzow commented 5 years ago

@lopuhin I have transifex account, and I already requested the addition of Japanese Could you please check?

lopuhin commented 5 years ago

@denzow sorry, I missed that - I added you now, if there is anything missing please let me know :)

denzow commented 5 years ago

@lopuhin I have three question.

lopuhin commented 5 years ago

Great questions @denzow

Are there any review rules ?

Not rules at the moment, but we want to do at least some review by a scrapy developer and native speaker before publishing.

If I want to invite my friends to the transifex project, will I need to ask you to invite them or will I invite myself?

Please do invite them. Unfortunately notifications from transifex are really unreliable, sometimes they are late a few days, and sometimes don't arrive at all - just now I accepted an invitation from 10 days ago, sorry for a delay.

Until this project is over, can I publish Japanese documents myself?

Yes, I think it makes sense to consider the docs translations as being under the same license as scrapy. Also if you would like to help with publishing them on https://doc.scrapy.org, that would be very welcome.

Somin-Kim commented 4 years ago

Hello, I'd like to translate docs to Korean. Since there is no Korean, I requested language. Could you check that please?

Gallaecio commented 4 years ago

Anyone willing to translate the Scrapy documentation once it is possible, please also consider working on a Scrapy article for the Wikipedia in your language.

sumit-jr commented 2 years ago

How to contribute to this issue. Can anyone help me with this. Actually i have translated scrappy wikipedia page to Nepali language. Can someone tell me how to contribute my work??

Gallaecio commented 2 years ago

Before translations can happen, internationalization needs to happen.