edx-platform icon indicating copy to clipboard operation
edx-platform copied to clipboard

feat: add brand_color variable for the email templates

Open bydawen opened this issue 1 year ago • 7 comments

Added a color variable to simplify branding of email templates used on different platforms. Also added a variable for the maximum height of the email logo image.

The main purpose of adding these variables is to be able to control the color used on buttons, links, etc. in emails. To avoid making these changes in many files, it can now be done by changing the value of one variable in the base_body template.

For example, as in the screenshot below, the size of the logo, the color of the button and links affected by brand_color variable which is setted here with the logo height. {% with brand_color="#1b511a" logo_max_height="65px" %}

Similar PR is opened to the master branch: https://github.com/openedx/edx-platform/pull/33421

Screenshot 2023-10-05 at 17 45 15

bydawen avatar Oct 27 '23 08:10 bydawen

Thanks for the pull request, @bydawen!

What's next?

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

:radio_button: 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.

:radio_button: 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

:radio_button: 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.

:radio_button: Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

:radio_button: 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

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

openedx-webhooks avatar Oct 27 '23 08:10 openedx-webhooks

Hi! I'm contributing on behalf of Raccoongang and PR is ready for review, thanks!

bydawen avatar Oct 27 '23 08:10 bydawen

Hi @bydawen! It looks like there's a failing check. Would you mind taking a look before we send to review? Thanks!

mphilbrick211 avatar Oct 27 '23 17:10 mphilbrick211

Hi @bydawen! It looks like there's a failing check. Would you mind taking a look before we send to review? Thanks!

@mphilbrick211 hello, tests are fixed, ready to go on review, thanks!

bydawen avatar Oct 30 '23 12:10 bydawen

We usually backport PR(s) after their corresponding master PR is merged. So we'll review this contribution against quince.master once that happens. Thanks!

mariajgrimaldi avatar Jan 22 '24 14:01 mariajgrimaldi

Hey @mariajgrimaldi 👋 What did you mean by

We usually backport PR(s) after their corresponding master PR is merged

I may misunderstand something, but the named master branches are never merged. (ref)

gabor-boros avatar Mar 05 '24 08:03 gabor-boros

Mater PR is merged, but then reverted next day. So I'm not going to merge this for now.

cmltaWt0 avatar Apr 07 '24 13:04 cmltaWt0

Hi @bydawen! Can this be closed, or does it need to remain open as a draft?

mphilbrick211 avatar Jul 30 '24 19:07 mphilbrick211

Closing for now due to inactivity.

mphilbrick211 avatar Aug 23 '24 20:08 mphilbrick211

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

openedx-webhooks avatar Aug 23 '24 20:08 openedx-webhooks