Skip to content

[WIP] Add french, japanese, and chinese #8

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
wants to merge 3 commits into from

Conversation

JulienPalard
Copy link
Member

@JulienPalard JulienPalard commented Dec 11, 2016

It's probably already in a nice state, but I'll still have to review this bit, I'm opening this pull request as a WIP to make it public.

There's still no crosslinks between translations, so this will still be invisible, but it's a nice step to test it slowly.

TODO:

  • Check, add if missing, rsync in salt configuration, as this commit use it.

See: https://bugs.python.org/issue26546 and https://mail.python.org/pipermail/python-ideas/2016-March/038879.html

This will typically be usefull when switching from hg to git or
git to hg, as git pull will fail on hg and vice-versa.

As a bonus, if repo does not exists, it's created.
So, we automatically create missing folders, and check if the venv is
here before running, as it's probably missing with temporary paths.
@berkerpeksag
Copy link
Member

-1.

Some thoughts:

  • The official Python documentation is actively maintained which means most of the translated content will eventually be outdated.
  • We will get a lot of non-English bug reports because people will think that we do officially maintain non-English versions of the Python documentation. Even now we occasionally get one or two bug reports about outdated translations. I've spent a lot of my free time answering invalid bug reports on various open source projects (including Python, python.org, Gunicorn and PyPI) and I would like avoid unnecessary work load.

@methane
Copy link
Member

methane commented Dec 12, 2016

The official Python documentation is actively maintained which means most of the translated content will eventually be outdated.

We use gettext and Transifex.
When English sentence is updated, the English sentence is shown instead of
outdated translated sentence is not shown, until we translate it again.

We will get a lot of non-English bug reports because people will think that we do officially maintain non-English versions of the Python documentation. Even now we occasionally get one or two bug reports about outdated translations. I've spent a lot of my free time answering invalid bug reports on various open source projects (including Python, python.org, Gunicorn and PyPI) and I would like avoid unnecessary work load.

I agree.
Each language must have split issue tracker. And HTML template for each language should point
their issue tracker.

@JulienPalard
Copy link
Member Author

The official Python documentation is actively maintained which means most of the translated content will eventually be outdated.

We're actually aware of this, as its already happening while we're translating. And it's a good thing, obviously, that the upstream is maintained. But we're translating faster than the documentation is updated so for us all translators, just translating the updates will be holidays compared to translating everything.

We will get a lot of non-English bug reports

Good point, it look like we'll need to update bugs.python.org to clearly announce some rules to avoid this.

@berkerpeksag
Copy link
Member

When English sentence is updated, the English sentence is shown instead of
outdated translated sentence is not shown, until we translate it again.

Which will lead to another type of bug reports: "This sentence is not translated."

Good point, it look like we'll need to update bugs.python.org to clearly announce some rules to avoid this.

Well, the problem is people won't read any of them. Also, bugs.p.o is not the only place to report documentation issues. They will use any Python related issue tracker like python.org and PyPI.

And no, using GitHub's issue template feature won't work. We do already use it in PyPI and people don't read it.

@methane
Copy link
Member

methane commented Dec 12, 2016

@berkerpeksag Isn't it a general issue of OSS world?
Do you have better idea?

@berkerpeksag
Copy link
Member

Do you have better idea?

Yes, I do: Let translations live out of docs.p.o domain :)

Another problem with this idea is that we don't actually have any control over these repositories and their content (e.g. what should we do if someone accidentally puts an offensive content? It's much easier to miss things like this in a smaller volunteer-only community than in a larger English speaking community.)

@JulienPalard
Copy link
Member Author

Yes, I do: Let translations live out of docs.p.o domain :)

That's killing a fly with a bazooka. letting translations out of the official repository mean hiding them. Here in France I met a bunch of python developpers, but no one aware of the french translation.

So, basically you're saying "Let's keep non-english speakers far away from Python, I fear they report bugs".

Another problem with this idea is that we don't actually have any control over these repositories and their content

That's why I opened the thread on Python-ideas, quote:

Where to host the translated files

Currently we're hosting the po files in the afpy's (Francophone
association for python) [6] github [1] but it may make sense to use (in
the generation scripts) a more controlled / restricted clone in the
python github, at least to have a better view of who can push on the
documentation.
We may want to choose between aggregating all translations under the
same git repository but I don't feel it's useful.

So, I'm not against moving po files to github.com/python/whatever, it even make sense, and it's possible with this PR as repository, branches, and versions are only configuration.

@berkerpeksag
Copy link
Member

So, basically you're saying "Let's keep non-english speakers far away from Python, I fear they report bugs".

Please keep the conversation civil. I'm also a non-native English speaker and I didn't say any of that. I'm pretty sure that there are Python conferences and users groups in your area. I suggest using them to promote your work instead of trying to blame other volunteers.

@JulienPalard
Copy link
Member Author

I'm not sure that keeping the translations out of d.p.o is a good way to avoid new issues: you said it yourself, b.p.o is already receiving issues about translations, even if they're almost known by nobody, so if we make them highly known (via conferences or via d.p.o), issues will flow anyway.

In the other hand translations are probably a good thing for Python accessibility, typically for young people, so I think it's worth the triaging time cost.

@JulienPalard
Copy link
Member Author

As it is controversial, discussion continues in a more public place: https://mail.python.org/pipermail/python-ideas/2017-January/044490.html

@JulienPalard
Copy link
Member Author

Closing this one, may reopen (probably another implementation) after further discussions following https://mail.python.org/pipermail/python-dev/2017-February/147416.html.

@JulienPalard JulienPalard deleted the python_doc_fr branch October 15, 2017 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants