Skip to content

Translations spring clean. #897

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 1 commit into from

Conversation

JulienPalard
Copy link
Member

As mentionned in #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.

Comment on lines -1675 to -1679
.. _doc_ja: https://docs.python.org/ja/
.. _doc_ko: https://docs.python.org/ko/
.. _doc_pl: https://docs.python.org/pl/
.. _doc_zh_cn: https://docs.python.org/zh-cn/
.. _doc_zh_tw: https://docs.python.org/zh-tw/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why removing these?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They look too obvious to be mentionned.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found them somewhat handy for two reasons:

  1. they show which translations have been already published;
  2. they provide an easy way to check the current published translation (instead of having to open d.p.o in a separate tab and selecting the language);

I think they might even deserve their own column.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we turn the entry in the Language column into a link to the docs when published?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea!

@ezio-melotti
Copy link
Member

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
Copy link
Member

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

@gvanrossum
Copy link
Member

Is this PR still needed? @JulienPalard

@safwansamsudeen
Copy link
Contributor

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

@CAM-Gerlach
Copy link
Member

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!

@safwansamsudeen
Copy link
Contributor

safwansamsudeen commented Jun 12, 2023

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.

@CAM-Gerlach
Copy link
Member

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.

@ezio-melotti
Copy link
Member

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.

@safwansamsudeen
Copy link
Contributor

@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.

@willingc willingc added the needs: PR update An update or rebase to an existing PR is needed. label Oct 10, 2023
@hugovk hugovk closed this in #1119 May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs: PR update An update or rebase to an existing PR is needed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants