devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Translations spring clean.

Open JulienPalard opened this issue 3 years ago • 9 comments

As mentionned in https://github.com/python/devguide/pull/896 some links were outdated.

Also keeping a link to an old initial email for a now mature translation with a repo and a presence on docs.python.org does not make sense.

JulienPalard avatar Jun 15 '22 08:06 JulienPalard

This has been moved to https://devguide.python.org/documentation/translating/ -- @JulienPalard do you want to update the PR, including the changes suggested in the review?

ezio-melotti avatar Jul 11 '22 23:07 ezio-melotti

There are also a few other improvements that can be done:

  • some translators have links to their email, others to their GitHub page, others don't have any links -- these could be cleaned up and made more consistent (e.g. for those that have a GitHub link, add the link to the @username)
  • the transifex link is repeated since multiple languages use it -- this could either be deduplicated, or links to the specific languages could be added if possible
  • the links could be comma-separated, or possibly more specific columns could be created

ezio-melotti avatar Jul 13 '22 22:07 ezio-melotti

Is this PR still needed? @JulienPalard

gvanrossum avatar Jan 20 '23 06:01 gvanrossum

If @JulienPalard isn't assigned to this anymore, can I work on it (if you feel it's required)?

safwansamsudeen avatar Jun 10 '23 14:06 safwansamsudeen

Sure, @safwansamsudeen . Do you have a clear idea of what needs to be done here? It should be mostly mechanical in nature, but you'll need to (manually, but its mostly mechanical) integrate these changes with the latest version of the translations table (now in its own separate file), as well as make the requested changes (or at least the first two, the third might take a little more effort and could be done separately):

  • Move the Python docs links to the text in the first column instead of at the end and linking them consistently, e.g.

    +-----------------+-------------------------------+----------------------------+
    | `Spanish (es)`  | Raúl Cumplido                 | `GitHub <github_es_>`_     |
    +-----------------+-------------------------------+----------------------------+
    
    .. _Spanish (es): https://docs.python.org/es/
    
  • Separate the remaining links on the right column by commas, and ensure the titles are consistent

  • Ensure there are consistent GitHub usernames and links for each of the translators in the middle column

I suggest you start in a fresh branch as that's probably simpler for you at this point; @JulienPalard can be added as a co-author to the commit metadata if he's okay with that.

We're happy to help further if you need additional guidance!

CAM-Gerlach avatar Jun 10 '23 18:06 CAM-Gerlach

How do I know which languages are published to see whether or not I should add the link?

EDIT: also, how do I edit the table easily - there seems to require a lot of effort managing the spaces and | aligning.

safwansamsudeen avatar Jun 12 '23 10:06 safwansamsudeen

How do I know which languages are published to see whether or not I should add the link?

You can tell what languages are published because they appear under the language selector on the docs homepage. The ones I see visible are these:

image

Also, you can find the links to the GitHub repos for the various language under a filtered version of the Python org repository list.

EDIT: also, how do I edit the table easily - there seems to require a lot of effort managing the spaces and | aligning.

Yeah, it can be quite tedious. I find it much easier in an editor (like Notepad++ on Windows, and many others) that offer a column mode and/or multi-line cursor features.

You could also convert it to a list table which avoids this problem and is generally much easier to work with, but you'd want to make a separate PR converting the table to list-table syntax first with no changes, have that merged, and then manually re-make these changes in another PR on top of that, which would be a good deal more time and effort on your part.

CAM-Gerlach avatar Jun 13 '23 00:06 CAM-Gerlach

Several editors have an edit mode that makes editing tables easier by allowing you to edit and move columns, e.g. https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_column-box-selection In this case, adding links to the existing table should be pretty straightforward, so it might be easier to stick with it rather than rewriting it as a list table.

ezio-melotti avatar Jun 13 '23 09:06 ezio-melotti

@CAM-Gerlach thanks for your help! I think converting into a list table would involve much more - IMO unproductive - effort. @ezio-melotti's solution sounds good, only I use IntelliJ, but I'll see.

safwansamsudeen avatar Jun 13 '23 09:06 safwansamsudeen