devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Add version requirements to the translation section of the dev guide

Open willingc opened this issue 5 months ago • 4 comments

but the minimum requirements are now fulfilled for all of 3.12, 3.13 and 3.14.

Hmm, we don't actually state in PEP 545 which version should meet the requirements. Something we should probably add in future amendments. cc @JulienPalard / @willingc

Originally posted by @StanFromIreland in https://github.com/python/docsbuild-scripts/issues/248#issuecomment-2987912733

This is a good suggestion. I'm opening an issue on the devguide to begin discussion about what makes sense among contributors to be a sensible default.

willingc avatar Jun 20 '25 19:06 willingc

I recommend the latest non-alpha branch, which is what most translations focus on. (e.g. all TX teams)

StanFromIreland avatar Jun 20 '25 19:06 StanFromIreland

Per the same thread, I'd support stating that we target the current latest (released) minor version.

A

AA-Turner avatar Jun 20 '25 19:06 AA-Turner

Thanks @StanFromIreland and @AA-Turner. Let's see what other folks think. IIRC I think @lysnikolaou had some thoughts at the Language Summit.

willingc avatar Jun 20 '25 20:06 willingc

I agree we should propose targeting the current latest minor version. However, I don't think that should be a hard requirement. Many language teams start as one person doing most of the work and that might mean they might not be able to translate all of the required files in time, at which point instead of doing more translations they would need to spend time on updating to the most recent version.

Thus I feel that becoming part of the language picker should be okay with even a slightly older version. Having something documented in their native language is better for our users than having nothing.

lysnikolaou avatar Jun 23 '25 15:06 lysnikolaou

(This was removed from the PR, as no conclusion was reached and still needs further discussion)

StanFromIreland avatar Aug 18 '25 14:08 StanFromIreland

This came up again, coordinator translated 3.13.7 (as suggested by @lysnikolaou IIUC, I would agree), but the docs (/3/) have changed in the meantime.

See https://github.com/python/docsbuild-scripts/pull/309#issuecomment-3237345005

StanFromIreland avatar Aug 29 '25 15:08 StanFromIreland

The current last minor version is X.Y, rather than X.Y.Z. As I said in that issue, given the website shows the latest changes, not frozen at the patch release, I think the translation target should be the state of the latest minor branch (i.e., currently 3.13).

As has been said a few times, the minimums in PEP 545 are very little -- a reader with no proficiency in English will get almost nothing out of it. We shouldn't aim to lower those requiremens, and perhaps should consider revisiting them to e.g. require that more of the stdlib or reference is translated before publication into the much more visible language switcher.

A

AA-Turner avatar Aug 29 '25 15:08 AA-Turner

We shouldn't aim to lower those requiremens, and perhaps should consider revisiting them to e.g. require that more of the stdlib or reference is translated before publication into the much more visible language switcher.

I previously suggested modifications, based on the statistically most read pages, in https://discuss.python.org/t/pep-545-update-language-switcher-requirements/75750.

I however tried to keep the amount of translation similar, adding to the switcher has been a motivational milestone for translations, raising the requirements may lead to de-motivation and unfortunately translators burning out.

StanFromIreland avatar Aug 29 '25 15:08 StanFromIreland