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: include paragon in atlas pull as well #622

Merged
merged 1 commit into from
Jul 22, 2023

Conversation

OmarIthawi
Copy link
Member

@OmarIthawi OmarIthawi commented Jul 22, 2023

This is a follow up to #612 . #612 should have included the changes but apparently OEP-58 needs more publicity.

Testing

I've ran the following:

$ OPENEDX_ATLAS_PULL=yes make pull_translations
$ cat src/i18n/index.js

Generates the following code, which seems to be good:

// This file is generated by the openedx/frontend-platform's "intl-import.js" script.
//
// Refer to the i18n documents in https://docs.openedx.org/en/latest/developers/references/i18n.html to update
// the file and use the Micro-frontend i18n pattern in new repositories.
//

import messagesFromParagon from './messages/paragon';
import messagesFromFrontendComponentHeader from './messages/frontend-component-header';
import messagesFromFrontendComponentFooter from './messages/frontend-component-footer';
// Skipped import due to missing 'frontend-template-application/index.js' likely due to empty translations..

export default [
  messagesFromParagon,
  messagesFromFrontendComponentHeader,
  messagesFromFrontendComponentFooter,
];

References

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

Up-to-date project overview and details are available in the Approach Memo and Technical Discovery: Translations Infrastructure Implementation document.

Join the conversation on Open edX Slack #translations-project-fc-0012.

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 Micro-frontends:

  • Legacy hardcoded translations are kept into the repo.
  • Consolidate all i18n imports into src/i18n/index.js
  • Add atlas integration in make pull_translations but only if OPENEDX_ATLAS_PULL is set
  • Bump frontend-platform and use intl-imports.js to generate up to date import files
  • If translations is missing, they're added according to the latest Micro-frontend i18n pattern in par with https://github.com/openedx/frontend-template-application/

This is a follow up to openedx#612

This pull request is part of the [FC-0012 project](https://openedx.atlassian.net/l/cp/XGS0iCcQ) which is sparked by the [Translation Infrastructure update OEP-58](https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0058-arch-translations-management.html#specification).
@openedx-webhooks
Copy link

Thanks for the pull request, @OmarIthawi! 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 Jul 22, 2023
@codecov
Copy link

codecov bot commented Jul 22, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (7594d0e) 0.00% compared to head (825346a) 0.00%.

Additional details and impacted files
@@          Coverage Diff           @@
##           master    #622   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files           2       2           
  Lines           7       7           
======================================
  Misses          7       7           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@adamstankiewicz adamstankiewicz merged commit bd04f02 into openedx:master Jul 22, 2023
6 checks passed
@openedx-webhooks
Copy link

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

@adamstankiewicz
Copy link
Member

Bump frontend-platform and use intl-imports.js to generate up to date import files

@OmarIthawi It might helpful to edit the instructions to indicate the minimum version of frontend-platform consumers need for using intl-imports.js, perhaps with a link to its release notes.

@OmarIthawi
Copy link
Member Author

Bump frontend-platform and use intl-imports.js to generate up to date import files

@OmarIthawi It might helpful to edit the instructions to indicate the minimum version of frontend-platform consumers need for using intl-imports.js, perhaps with a link to its release notes.

Good catch @adamstankiewicz , I've already gone through all MFEs and updated them. This line should be removed from my pull request templates.

As you probably guess, this template is copied to provide as much information as possible for anyone reviewing the PRs related to OEP-58.

@OmarIthawi OmarIthawi deleted the paragon-atlas branch July 23, 2023 12:30
@adamstankiewicz
Copy link
Member

adamstankiewicz commented Jul 23, 2023

@OmarIthawi Got it! Just a heads up, I don't have access to the link you shared 😀 thanks for the clarification.

@OmarIthawi
Copy link
Member Author

OmarIthawi commented Jul 23, 2023

@OmarIthawi Got it! Just a heads up, I don't have access to the link you shared grinning thanks for the clarification.

Sorry, I've made it public now.

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

3 participants