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

backport chore: provide logo url from backend for batch enrollment email (#35138) #35378

Conversation

mudassir-hafeez
Copy link
Contributor

Ticket for internal tracking

https://github.com/mitodl/hq/issues/4923

Description

This PR is a backport of the changes made in PR #35138 to the open-release/quince.master branch.

For the past couple of years, edX has supported a logo URL from the backend for Bulk Email and edX ACE emails. But, this does not have similar support for emails using batch enrollment. Not sure if it is intentional or could have some other reasons but it causes the logo URL to be missed if it needs to be passed from the backend similar to Bulk Email and edX ACE emails.

This pull request addresses the logo not appearing in batch enrollment emails when the logo URL is set in the backend and accessed in the template(or custom theme) similar to how edX Bulk or ACE email use.

Useful information to include:

  • No UI changes were made, so no screenshots are necessary.

Supporting information

Testing instructions

  • Ensure that LOGO_URL_PNG_FOR_EMAIL or any of the settings accessed in this code is set.
  • Go to the Membership tab in the Instructor Dashboard with a user having staff access.
  • Send a Batch Enrollment or Batch Beta Tester email.
  • Verify that the logo appears correctly in the email.

Other information

  • This change is isolated to the email template logic and does not depend on other changes.
  • No database migrations are involved.

…edx#35138)

* chore: provide logo url from backend for batch enrollment email
@openedx-webhooks
Copy link

Thanks for the pull request, @mudassir-hafeez!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 26, 2024
@mphilbrick211 mphilbrick211 added backport PR backports a change from main to a named release. needs reviewer assigned PR needs to be (re-)assigned a new reviewer labels Aug 26, 2024
@ziafazal ziafazal self-requested a review August 27, 2024 07:01
Copy link
Contributor

@ziafazal ziafazal left a comment

Choose a reason for hiding this comment

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

👍

@ziafazal ziafazal merged commit 493e7ef into openedx:open-release/quince.master Aug 27, 2024
43 checks passed
@openedx-webhooks
Copy link

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

@mudassir-hafeez mudassir-hafeez deleted the mudassir/backport_logo_url_from_backend_for_batch_enrollment branch August 27, 2024 07:25
@itsjeyd itsjeyd removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Sep 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport PR backports a change from main to a named release. open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants