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

feat: standardize translation directory for i18n_tool #96

Merged
merged 3 commits into from
Apr 24, 2023

Conversation

shadinaif
Copy link

@shadinaif shadinaif commented Apr 14, 2023

feat: standardize translation directory for i18n_tool

This PR prepares the repository to comply with openedx-translations by doing the following:

  • Create conf/locale directory. This is the default used one in openedx-translations
  • Make the translation command make extract_translations build a file named django.po . This is the entry command used in openedx-translations
  • Remove translation in test files!
  • Enable i18n translation in template files + fix a test that fails when i18n is enabled
  • Tested on local devstack palm to ensure that everything renders fine
  • Tested on local devstack palm to ensure that local translation still works no local translation exists in this repo

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 openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 14, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Apr 14, 2023

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.

@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58 branch 8 times, most recently from 2782bea to 0df6e7d Compare April 15, 2023 09:15
@shadinaif shadinaif marked this pull request as ready for review April 15, 2023 09:23
shadinaif added a commit to Zeit-Labs/openedx-translations that referenced this pull request Apr 15, 2023
shadinaif added a commit to Zeit-Labs/openedx-translations that referenced this pull request Apr 15, 2023
@shadinaif
Copy link
Author

@OmarIthawi, @brian-smith-tcril this one is ready for your review. Thank you!

Copy link
Member

@OmarIthawi OmarIthawi left a comment

Choose a reason for hiding this comment

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

If this repo has no javascript translations, then this look good to me.

@@ -7,7 +7,6 @@

from unittest import mock
from django.test.client import Client
from django.utils.translation import ugettext as _
Copy link
Member

Choose a reason for hiding this comment

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

Great! ugettext makes no sense in testing. At least, wasn't a good way to test i18n.

@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Apr 19, 2023
@brian-smith-tcril brian-smith-tcril removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Apr 20, 2023
Copy link

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

LGTM! :shipit:

@sarina sarina merged commit b3ac71a into openedx:master Apr 24, 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.

shadinaif added a commit to Zeit-Labs/openedx-translations that referenced this pull request Apr 25, 2023
shadinaif added a commit to Zeit-Labs/openedx-translations that referenced this pull request Apr 26, 2023
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.

6 participants