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

feat: pass required context for instructor emails

Open DmytroAlipov opened this issue 1 year ago • 15 comments

Description

Pass required context to bulk enrollment emails:

  • logo_url
  • homepage_url
  • dashboard_url

Add additional context for enrollment emails:

  • contact_email
  • platform_name

There is no required context for base_body.html

DmytroAlipov avatar Jul 03 '23 09:07 DmytroAlipov

Thanks for the pull request, @DmytroAlipov!

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: 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 Jul 03 '23 09:07 openedx-webhooks

@e0d Here the problem is apparently not in the tests themselves

DmytroAlipov avatar Jul 14 '23 06:07 DmytroAlipov

@DmytroAlipov rerunning seems to have fixed the failure, will also update the branch.

e0d avatar Jul 14 '23 10:07 e0d

Hi @openedx/teaching-and-learning! Would someone be able to review/merge this for us? Thanks!

mphilbrick211 avatar Jul 25 '23 20:07 mphilbrick211

Hi @openedx/teaching-and-learning! Would someone be able to review/merge this for us? Thanks!

Hi @openedx/teaching-and-learning! Just following up on this.

mphilbrick211 avatar Aug 23 '23 01:08 mphilbrick211

Hi @DmytroAlipov - flagging the new tests that have popped up per the recent update: https://discuss.openedx.org/t/minor-change-to-edx-platform-check-statuses/11131

mphilbrick211 avatar Sep 12 '23 18:09 mphilbrick211

done

DmytroAlipov avatar Sep 13 '23 11:09 DmytroAlipov

Hi @openedx/teaching-and-learning! Friendly ping on this.

mphilbrick211 avatar Sep 14 '23 13:09 mphilbrick211

Hi @openedx/teaching-and-learning! Following up on this for review.

mphilbrick211 avatar Oct 24 '23 21:10 mphilbrick211

@mphilbrick211 @DmytroAlipov I can help review this PR as CC.

navinkarkera avatar Mar 06 '24 12:03 navinkarkera

Thank you, @navinkarkera!

mphilbrick211 avatar Mar 08 '24 20:03 mphilbrick211

@DmytroAlipov Can you add a bit more context in the description. Were these variables missing before? Why don't we use the whole message_context from get_base_template_context function instead of getting these variables one by one?

    param_dict.update(message_context)

navinkarkera avatar Mar 13 '24 11:03 navinkarkera

Hi, @navinkarkera There is no required context for openedx/core/djangoapps/ace_common/templates/ace_common/edx_ace/common/base_body.html:

  • homepage_url
  • logo_url
  • dashboard_url
  • platform_name
  • contact_email

There is no point in transmitting the entire message_context since we need a limited number of parameters.

DmytroAlipov avatar Mar 20 '24 12:03 DmytroAlipov

@DmytroAlipov Apologies for delay in response. contact_email doesn't seem to be used anywhere in base_body, are we using it in some other template?

navinkarkera avatar Apr 02 '24 09:04 navinkarkera

Hi @navinkarkera

Yes, this is not used. I may have transferred this from our developments and we used it.

If this parameter interferes too much, I can remove it. But if it’s not critical, then let it remain.

DmytroAlipov avatar Apr 02 '24 10:04 DmytroAlipov

@navinkarkera Friendly pign.

DmytroAlipov avatar Apr 21 '24 12:04 DmytroAlipov

@DmytroAlipov Thanks for the reminder.

All the examples of base template context seems to use the whole context instead of picking some values from it as the base template infact makes use of these variables. For example: social_media_urls etc.

I am not able to understand your reasoning behind selecting some of the variables here.

navinkarkera avatar Apr 26 '24 06:04 navinkarkera

Hi @DmytroAlipov @navinkarkera - is this still in-progress?

mphilbrick211 avatar Jul 30 '24 19:07 mphilbrick211