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 make extract_translations #212

Merged

Conversation

shadinaif
Copy link
Contributor

@shadinaif shadinaif commented Apr 27, 2023

feat: standardize make extract_translations

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

  • Delete locale directory as it's not needed
  • Fix the translation command make extract_translations to use django-admin instead of manage.py. And fix cd edx-ace to the correct path cd edx_ace
  • Tested on local devstack palm to ensure that everything renders fine
  • Tested on local devstack palm to ensure that local translation still works there is no translation 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

Sorry, something went wrong.

@openedx-webhooks
Copy link

openedx-webhooks commented Apr 27, 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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 27, 2023
shadinaif added a commit to zeit-labs/openedx-translations that referenced this pull request Apr 27, 2023
This PR needs openedx/edx-ace#212 before it's merged.

Refs: FC-0012 OEP-58
@shadinaif
Copy link
Contributor Author

The failing test is codecov issue

@shadinaif
Copy link
Contributor Author

Ready for your review @OmarIthawi @brian-smith-tcril

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.

The other files looks good, but I'd like to double check the config.yaml removal.

@@ -1,72 +0,0 @@
# Configuration for i18n workflow.
Copy link
Member

Choose a reason for hiding this comment

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

@shadinaif what's the impact of removing the config.yaml file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@OmarIthawi it is not used, there is no transifex edx-ace. On the other hand, config.yml already exist in conf/locale directory before this PR

@OmarIthawi OmarIthawi marked this pull request as draft April 27, 2023 17:55
@shadinaif shadinaif force-pushed the shadinaif/FC-0012-OEP-58 branch from 981b790 to 7b1e5a6 Compare May 3, 2023 13:28
@shadinaif shadinaif marked this pull request as ready for review May 3, 2023 13:33
@shadinaif shadinaif requested a review from OmarIthawi May 3, 2023 13:33
@brian-smith-tcril
Copy link

@mphilbrick211 this one should be good to go! It's marked as "No extra review required" on the spreadsheet so it should just be a matter of finding a CC with perms on the repo to review/merge!

@mphilbrick211 mphilbrick211 requested a review from zainab-amir May 3, 2023 17:41
@mphilbrick211
Copy link

Hi @openedx/vanguards / @zainab-amir! Would someone be able to merge this for us? Thanks!

@brian-smith-tcril brian-smith-tcril merged commit db15604 into openedx:master May 9, 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 May 9, 2023
This PR needs openedx/edx-ace#212 before it's merged.

Refs: FC-0012 OEP-58
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.

None yet

5 participants