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

fix: JS translation missing locale directory #326

Merged
merged 2 commits into from
May 26, 2023

Conversation

shadinaif
Copy link
Contributor

@shadinaif shadinaif commented May 12, 2023

We removed locale symbolic link but forgot to set it manually in settings.py JS compilation for translations will not find source translation files without this fix

This is still needed until we remove all local translations at the end of the project. Otherwise, make compile_translations will empty out all JS translations in public/js/translations directory

The PR also fixes make extract_translations to use msgcat instead of tail

Related to work done in #316

References

This pull request is part of the FC-0012 project which is sparked by the Translation Infrastructure update OEP-58.

Check the links above for full information about the overall project.

Internalization is being rearchitected in Open edX Python, XBlock, Micro-frontend, and other projects. There are a number of immediately visible changes:

  • Remove source and language translations from the repositories, hence no .json, .po or .mo files will be committed into the repos.
  • Add standardized make extract_translations in all repositories
  • Push user-facing messages strings into openedx/openedx-translations.
  • Integrate root repositories with openedx/openedx-atlas to pull translations on build/deploy time

Breaking Changes

One of the primary goals of the project is to avoid breaking changes. If you noticed any suspicious code, please raise your concern. But before that, please know the strategy we're following to avoid breaking changes

For XBlocks:

  • The standard translation path must be conf/locale. Therefore, we are creating a link from conf/locale to translations so Atlas can find the path without disrupting the current way of having translations locally within the XBlocks
  • openedx-translations will have a related PR that adds the XBlock to the pipeline. This will not affect the current way of managing/updating translations
  • At the end of the project, a clear change log will be added and all translations will be handled by Atlas. Thus, the local translation will be removed from the repo within the version bump
  • A notification for the community will be published to ensure that everyone knows why translations directories are removed from all repos

@openedx-webhooks
Copy link

Thanks for the pull request, @shadinaif! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

1 similar comment
@openedx-webhooks
Copy link

Thanks for the pull request, @shadinaif! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 12, 2023
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58.02 branch 3 times, most recently from 463ffe6 to 3461ce8 Compare May 14, 2023 10:41
@itsjeyd
Copy link
Contributor

itsjeyd commented May 16, 2023

Thanks for the contribution, @shadinaif!

Please let us know when it's ready for review.

@itsjeyd itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label May 16, 2023
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58.02 branch from 3461ce8 to 2e354c0 Compare May 16, 2023 14:04
@shadinaif
Copy link
Contributor Author

Thank you @itsjeyd , it is ready. Just forgot to mention that 😅 . I've rebased on master a moment ago

@Agrendalath
Copy link
Member

@shadinaif, ack. I'll review this tomorrow.

@Agrendalath Agrendalath self-requested a review May 16, 2023 14:52
Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

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

@shadinaif, we don't need to update the version here, but please add the following section to Changelog.md:

Unreleased
----------

* <description of this change>

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
We removed `locale` symbolic link but forgot to set it manually in settings.py
JS compilation for translations will not find source translation files without this fix

Refs: FC-0012 OEP-58
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58.02 branch 2 times, most recently from cbc484a to 97398af Compare May 22, 2023 10:47
@shadinaif
Copy link
Contributor Author

Thanks for your review @Agrendalath . Please check my replies above

@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58.02 branch 3 times, most recently from 5091f0f to 0d5247b Compare May 22, 2023 15:19
Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

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

👍

  • I tested this: checked that the translations CI is passing
  • I read through the code
  • I checked for accessibility issues: n/a
  • Includes documentation: n/a
  • I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository: n/a

@itsjeyd itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label May 23, 2023
tail can produce duplicate messages in djang.po which will raise an error in compilemessages

Refs: FC-0012 OEP-58
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58.02 branch from 0d5247b to d7d2eb0 Compare May 26, 2023 12:43
@Agrendalath Agrendalath merged commit c6c7285 into openedx:master May 26, 2023
@openedx-webhooks
Copy link

@shadinaif 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

1 similar comment
@openedx-webhooks
Copy link

@shadinaif 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants