Skip to content
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

Add locale check script + CI job, that runs gettext check #12394

Closed
wants to merge 6 commits into from

Conversation

n-peugnet
Copy link
Contributor

@n-peugnet n-peugnet commented May 28, 2024

Subject: Add script + CI job to check locale files with gettext

Feature or Bugfix

  • Test

Purpose

  • To avoid having to manually check submitted translations, it can be usefull to quickly check that the translation files are correct using gettext.

Relates

P.S. The docs build will be fixed by #12395

sphinx/locale/Makefile Show resolved Hide resolved
sphinx/locale/Makefile Show resolved Hide resolved
@chrisjsewell
Copy link
Member

chrisjsewell commented May 29, 2024

Heya thanks,

My main question though, that I've asked previously (https://github.com/orgs/sphinx-doc/discussions/12249#discussioncomment-9062264) is what is the workflow for submitting translations?

At present it seems that it is NOT directly through this repository; it "should" be done at https://explore.transifex.com/sphinx-doc/

If this is the case, then essentially this PR is not needed, and we should "reject" all PRs like #12392, and show them how to do it on transifex

I feel, at a minimum, we at least need to document this better

@n-peugnet
Copy link
Contributor Author

@chrisjsewell:

At present it seems that it is NOT directly through this repository; it "should" be done at https://explore.transifex.com/sphinx-doc/

If this is the case, then essentially this PR is not needed, and we should "reject" all PRs like #12392, and show them how to do it on transifex

It feels a little bit sad to force the translations to be created via Transifex for at least 2 reasons:

  • It requires yet another account to even see the translated strings. Let alone contributing
  • It forces to use a WebUI, which prevent translators from using the editor/tool they are used to.

As I see it, Transifex can be a great addition to help new translators contribute (though for this purpose I find Weblate more interesting, as it allows to see what the tool looks like even before registering an account). But IMO it should not be a requirement to contribute to translations.

Having said that, maybe the current translation workflow is more hierarchical than I thought and needs a review by translation maintainers, but I can't see it because I didn't register an account on Transifex. So I agree with your last point:

I feel, at a minimum, we at least need to document this better

@chrisjsewell
Copy link
Member

It feels a little bit sad to force the translations to be created via Transifex

Oh exactly, I can't see anything now also and have no idea of what actual work is going on within transifex and if there is an active community there 😒 (and I'm certainly not paying!)

image

So I certainly don't think its great to make contributors use this, and would certainly be open to alternatives

Having said that, maybe the current translation workflow is more hierarchical than I thought and needs a review by translation maintainers

But yes I just feel, before we start changing things in this repo, we should probably make sure we are clear about how we are actually doing translations

@n-peugnet n-peugnet force-pushed the locale-check branch 6 times, most recently from 26a21d6 to 6dd29a7 Compare June 2, 2024 15:13
@chrisjsewell
Copy link
Member

@rffontenelle maybe you wanted to quickly check this also, since you are doing the work on https://github.com/sphinx-doc/sphinx-doc-translations

@jayaddison jayaddison added i18n github_actions Pull requests that update GitHub Actions code labels Jun 10, 2024
@n-peugnet
Copy link
Contributor Author

Since currently the .po files directly modified in this repo are not pushed back to transifex (see #12392 (comment)), it does not make sense to add this check here.

But instead, maybe a check --fix script as described in sphinx-doc/sphinx-doc-translations#36 (comment) could be used when pulling the translations in GitHub actions, before pushing them back right after.

@n-peugnet n-peugnet closed this Jul 10, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
github_actions Pull requests that update GitHub Actions code i18n
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants