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.

Sign up for GitHub

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

Jump to bottom

feat: pass required context for instructor emails #32625

Closed
wants to merge 1 commit into from
Closed

feat: pass required context for instructor emails #32625

wants to merge 1 commit into from

Conversation

DmytroAlipov
Copy link
Contributor

@DmytroAlipov DmytroAlipov commented Jul 3, 2023 •
edited
Loading

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

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

openedx-webhooks commented Jul 3, 2023 •
edited
Loading

Thanks for the pull request, @DmytroAlipov!

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.

@DmytroAlipov
Copy link
Contributor Author

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

@DmytroAlipov DmytroAlipov mentioned this pull request Jul 14, 2023
Closed
@e0d
Copy link
Contributor

e0d commented Jul 14, 2023

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

@mphilbrick211 mphilbrick211 requested a review from a team July 25, 2023 20:49
@mphilbrick211
Copy link

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

@mphilbrick211 mphilbrick211 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Aug 23, 2023
@mphilbrick211
Copy link

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
Copy link

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

@DmytroAlipov DmytroAlipov force-pushed the add-required-context-for-instructor-emails branch from e484caa to 15b753f Compare September 13, 2023 11:24
@DmytroAlipov
Copy link
Contributor Author

done

@mphilbrick211
Copy link

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

@DmytroAlipov DmytroAlipov force-pushed the add-required-context-for-instructor-emails branch from 15b753f to a4635f4 Compare October 4, 2023 05:44
@mphilbrick211
Copy link

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

@navinkarkera
Copy link
Contributor

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

@mphilbrick211
Copy link

Thank you, @navinkarkera!

@navinkarkera
Copy link
Contributor

@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 navinkarkera added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Mar 13, 2024
@DmytroAlipov
Copy link
Contributor Author

DmytroAlipov commented Mar 20, 2024 •
edited
Loading

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 DmytroAlipov mentioned this pull request Mar 20, 2024
Open
@DmytroAlipov DmytroAlipov force-pushed the add-required-context-for-instructor-emails branch from a4635f4 to a565854 Compare March 20, 2024 19:48
@DmytroAlipov
feat: pass required context for instructor emails
f8b9c6b 
pass required context to bulk enrollment emails:
  - logo_url
  - homepage_url
  - dashboard_url
add additional context for enrollment emails:
  - contact_email
  - platform_name
@DmytroAlipov DmytroAlipov force-pushed the add-required-context-for-instructor-emails branch from a565854 to f8b9c6b Compare March 20, 2024 19:52
@navinkarkera
Copy link
Contributor

navinkarkera commented Apr 2, 2024 •
edited
Loading

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

@DmytroAlipov
Copy link
Contributor Author

DmytroAlipov commented Apr 2, 2024 •
edited
Loading

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.

@mphilbrick211 mphilbrick211 removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Apr 2, 2024
@DmytroAlipov
Copy link
Contributor Author

@navinkarkera Friendly pign.

@navinkarkera
Copy link
Contributor

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

@mphilbrick211
Copy link

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

@navinkarkera navinkarkera added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Aug 1, 2024
@mphilbrick211
Copy link

Hi @DmytroAlipov! Are you still pursuing this pull request, or can it be closed?

@mphilbrick211 mphilbrick211 added the inactive PR author has been unresponsive for several months label Oct 30, 2024
@mphilbrick211 mphilbrick211 added closed inactivity PR was closed because the author abandoned it and removed inactive PR author has been unresponsive for several months labels Nov 26, 2024
@DmytroAlipov DmytroAlipov deleted the add-required-context-for-instructor-emails branch November 27, 2024 07:57
@itsjeyd itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
closed inactivity PR was closed because the author abandoned it open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@DmytroAlipov @openedx-webhooks @e0d @mphilbrick211 @navinkarkera @itsjeyd