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: FC-0012 - add atlas support for cookiecutter-django-app #392

Merged

Conversation

shadinaif
Copy link
Contributor

feat: add atlas support for cookiecutter-django-app

Update cookiecutter-django-app to support atlas for all new apps

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

Only for cookiecutter-django-app:

  • Use i18_tool extract to extract transactions

How it was tested?

  • Create a django app using the cookiecutter cookiecutter -o testdir cookiecutter-django-app
  • go to the new app project directory
  • Create a virtualenv and upgrade requirements using make upgrade
  • Install the requirements make requirements
  • try make extract_translations: everything looks fine
  • try make validate: no errors

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 notice 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 translation directories are removed from all repos

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

@shadinaif
Copy link
Contributor Author

ready for 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.

Thanks @shadinaif, it looks good and needs the following changes to be ready:

  • atlas pull needs to be added to Makefile
  • openedx-atlas pip requirement is needed.

@OmarIthawi OmarIthawi added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Sep 21, 2023
@OmarIthawi
Copy link
Member

@brian-smith-tcril @e0d would you mind enabling tests for this pull request?

@OmarIthawi OmarIthawi removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Sep 22, 2023
Update cookiecutter-django-app to support atlas for all new apps

Refs: FC-0012 OEP-58
@shadinaif shadinaif force-pushed the shadinaif/atlas-aupport-django-app branch from 96662db to 17c45df Compare September 30, 2023 10:14
@OmarIthawi
Copy link
Member

@brian-smith-tcril another approval here for the pull request tests please.

@itsjeyd itsjeyd added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Oct 10, 2023
@itsjeyd
Copy link

itsjeyd commented Oct 10, 2023

@shadinaif A similar note here: This PR seems to be part of FC-0012. Would you mind updating the title to reflect that?

@brian-smith-tcril We've got a green build so this is ready for final review/merge.

@shadinaif shadinaif changed the title feat: add atlas support for cookiecutter-django-app feat: FC-0012 - add atlas support for cookiecutter-django-app Oct 10, 2023
@shadinaif
Copy link
Contributor Author

Title updated @itsjeyd , 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.

I've tested it and it works right. Thanks @shadinaif!!

@brian-smith-tcril
Copy link

@jmbowman you are listed as "Please inform" on the spreadsheet. I plan on merging this one tomorrow morning, so please let me know if you have any objections.

@brian-smith-tcril brian-smith-tcril merged commit 2984ce8 into openedx:master Oct 11, 2023
4 checks passed
@shadinaif shadinaif deleted the shadinaif/atlas-aupport-django-app branch October 12, 2023 06:19
@itsjeyd itsjeyd removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Oct 17, 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.

5 participants