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: add brand_color variable for the email templates #33606

Conversation

bydawen
Copy link
Contributor

@bydawen bydawen commented Oct 27, 2023

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:
#33421

Screenshot 2023-10-05 at 17 45 15

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 27, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Oct 27, 2023

Thanks for the pull request, @bydawen!

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.

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

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

@bydawen
Copy link
Contributor Author

bydawen commented Oct 27, 2023

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

@mphilbrick211 mphilbrick211 added the backport PR backports a change from main to a named release. label Oct 27, 2023
@mphilbrick211
Copy link

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

@bydawen bydawen force-pushed the feat/quince/email-template-color-branding branch from dbc97b9 to 56f25ba Compare October 30, 2023 10:25
@bydawen
Copy link
Contributor Author

bydawen commented Oct 30, 2023

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 bydawen force-pushed the feat/quince/email-template-color-branding branch from 56f25ba to 3154bf9 Compare November 16, 2023 10:01
@mariajgrimaldi
Copy link
Member

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!

@cmltaWt0 cmltaWt0 added product review PR requires product review before merging and removed product review PR requires product review before merging labels Feb 6, 2024
@gabor-boros
Copy link
Contributor

gabor-boros commented Mar 5, 2024

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 gabor-boros self-requested a review March 5, 2024 08:05
@cmltaWt0
Copy link
Contributor

cmltaWt0 commented Apr 7, 2024

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

@bydawen bydawen marked this pull request as draft April 8, 2024 07:02
@mphilbrick211
Copy link

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

@mphilbrick211
Copy link

Closing for now due to inactivity.

@openedx-webhooks
Copy link

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

@mphilbrick211 mphilbrick211 added the closed inactivity PR was closed because the author abandoned it label Aug 23, 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. closed inactivity PR was closed because the author abandoned it 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.

6 participants