Skip to content

Translating documents to Persian language #18946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mehrdad-dev opened this issue Nov 30, 2020 · 23 comments
Closed

Translating documents to Persian language #18946

mehrdad-dev opened this issue Nov 30, 2020 · 23 comments

Comments

@mehrdad-dev
Copy link

mehrdad-dev commented Nov 30, 2020

I decided that translating scikit-learn documents to Persian. before it i have a experience with translating Andrew Ng machine learning course to Persian.
Can you describe for me that how can i do it?
I really want to help Persian community to learn the scikit-learn!
i read FAQ page, but nothing was written about translating it.

Thanks a lot.

@cmarmo
Copy link
Contributor

cmarmo commented Dec 1, 2020

Hi @mehrdad-dev, thanks for reaching out. At some point scikit-learn devs decided not to translate the documentation from English because the human cost of maintaining the translated pages is not affordable right now. I don't know if the team is willing to push for this or not.

@mehrdad-dev
Copy link
Author

Hi @cmarmo thanks for response.
How do we know that it is possible?
I think we can do it in a simple GitHub page or something else that don't need a additional resources ...

@cmarmo
Copy link
Contributor

cmarmo commented Dec 1, 2020

I've asked around. Indeed we don't have the manpower to manage a multilingual installation and the translations, but if you decide to work on that and host it on your github pages we can link to your work.

@mehrdad-dev
Copy link
Author

Can't I control and manage it myself?

@cmarmo
Copy link
Contributor

cmarmo commented Dec 1, 2020

Can't I control and manage it myself?

Yes, feel free.

@mehrdad-dev
Copy link
Author

Ok, so if we create a github page for it and later introduce it to you in a issue, is it legally and the organization put it link in documentation?

@cmarmo
Copy link
Contributor

cmarmo commented Dec 2, 2020

Ok, so if we create a github page for it and later introduce it to you in a issue, is it legally and the organization put it link in documentation?

Exactly. Just one more suggestion: scikit-learn documentation code is distributed under the BSD License, I believe it is a good idea to keep the same for your translation. Thanks!

@mehrdad-dev
Copy link
Author

Yes we keep it.
Thanks a lot.

@mehrdad-dev
Copy link
Author

Hi again @cmarmo .
We decided to translate the tutorial section of the website.
So before starting, do you have any recommendations or something?

Thanks.

@mehrdad-dev mehrdad-dev reopened this Dec 5, 2020
@cmarmo
Copy link
Contributor

cmarmo commented Dec 5, 2020

Hi @mehrdad-dev there is an open issue about tutorials (#18257) that makes this section not optimal for you to start, I think. May I suggest to start from the "Getting Started" section and then proceed to the User Guide?

@mehrdad-dev
Copy link
Author

Yes sure. thanks for your suggest.

@mehrdad-dev
Copy link
Author

mehrdad-dev commented Dec 6, 2020

Is it better to create an github organization (like:"scikit-learn in Farsi") for this or is a simple repo enough?

@cmarmo
Copy link
Contributor

cmarmo commented Dec 6, 2020

Let's start simple with a personal repo, it will be easy to change ownership to an organization if your project become bigger.

@mehrdad-dev
Copy link
Author

Hi @cmarmo
we are create the repo: https://github.com/mehrdad-dev/scikit-learn
and the website address is: https://sklearn.ir/

Now, we are starting to work.

please add this link to the documentations.

@mehrdad-dev
Copy link
Author

@cmarmo we are waiting for your response

@cmarmo
Copy link
Contributor

cmarmo commented Dec 9, 2020

@cmarmo we are waiting for your response

... I believe I did not understand the question then. I've seen you started the translation and that's awesome. Adding a link to the webpage needs a pull request and a decision about where the link should be put. This is not a blocker for you right? Thanks for your patience.

@mehrdad-dev
Copy link
Author

alright, so
Do we have to add the translated link of each page to that page itself?
Or introduce it all on a specific page?

@cmarmo
Copy link
Contributor

cmarmo commented Dec 9, 2020

@mehrdad-dev I've opened an issue for discussion (#18984 )

@NicolasHug
Copy link
Member

Thanks for working on a translation @mehrdad-dev

It'd be nice if the translation made it explicit that it's not the official docs. Maybe as a banner or as a note on the main page? In particular, it's important to mention that:

  • the translation is a volunteer effort and the only official/latest version of the docs is https://scikit-learn.org/
  • the sklearn team has no control on this translation, and it may be outdated
  • if any issue with the translation, issues should be directed to the translation repo, not to the scikit-learn repo

@mehrdad-dev
Copy link
Author

Yes, sure
We will add these three paragraphs to the about page.

@mehrdad-dev
Copy link
Author

Hi dear @cmarmo.
We are finished translating the getting-started section.
So, How can we add a reference link to original documentation?

translated link of getting-started to Persian: https://sklearn.ir/getting-started

Thanks.

@cmarmo
Copy link
Contributor

cmarmo commented Dec 28, 2020

So, How can we add a reference link to original documentation?

#18984 is waiting for the correspondent pull request to be merged. Thanks a lot for your work so far!

@cmarmo
Copy link
Contributor

cmarmo commented May 26, 2021

I'm closing this one as the link is now available from the scikit-learn documentation.

@cmarmo cmarmo closed this as completed May 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants