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

docs: add MFE and Microservices OEP-58 instructions #384

Closed
wants to merge 1 commit into from

Conversation

OmarIthawi
Copy link
Member

@OmarIthawi OmarIthawi commented Sep 20, 2023

Fill in the missing steps for both microservices and micro-frontends.

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

@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.

Copy link
Contributor

@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.

This is great! I left a couple tiny suggestions but other than that this looks like it's good to go!

Comment on lines 93 to 98
#. If you are creating a new repository, use the `cookiecutter-django-ida`_
template.

**TODO:** How to enable translations infrastructure on a Django microservice
#. For existing repos which don't have the ``make extract_translations`` or
``make pull_translations`` command, they can be copied from the
`edx-cookiecutters`_ Makefile in the ``cookiecutter-django-ida`` Makefile for Microservices.
Copy link
Contributor

Choose a reason for hiding this comment

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

Having these as numbered steps in a row makes this somewhat confusing. It currently renders as

  1. If you are creating a new repository
  2. For existing repos

It seems to me they should both be part of step 1.

Comment on lines 131 to 135
#. If you are creating a new repository, use `frontend-template-application`_.

**TODO:** How to enable translations infrastructure on a React repo
#. For existing repos which don't have the ``make extract_translations`` or
``make pull_translations`` command, they can be copied from the
`frontend-template-application Makefile`_.
Copy link
Contributor

Choose a reason for hiding this comment

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

same note as the microservice one

Copy link
Member Author

Choose a reason for hiding this comment

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

Both are done. Good catch.

@openedx-webhooks
Copy link

@OmarIthawi Even though your pull request wasn’t 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
None yet
Development

Successfully merging this pull request may close these issues.

3 participants