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: set links for CourseAuthoring discussion alert #35406

Merged
merged 1 commit into from
Sep 26, 2024
Merged

feat: set links for CourseAuthoring discussion alert #35406

merged 1 commit into from
Sep 26, 2024

Conversation

CefBoud
Copy link
Contributor

@CefBoud CefBoud commented Aug 30, 2024

Description

There is an alert in CourseAuthoring MFE to inform about the usage of an upgraded version of discussion. This PR sets the links used in that alert instead of defaulting to the having clickable empty links.

Testing instructions

Please refer to the related MFE PR openedx/frontend-app-authoring#1245

ref

BB-9079

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 30, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @CefBoud!

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.

@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Aug 30, 2024
pdpinch
pdpinch requested changes Sep 4, 2024
View reviewed changes
cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_index.py Outdated
"discussions_incontext_feedback_url": "",
"discussions_incontext_learnmore_url": "",
"discussions_incontext_feedback_url": "https://discuss.openedx.org/t/new-and-improved-discussions-forum/9183", # lint-amnesty, pylint: disable=line-too-long
"discussions_incontext_learnmore_url": "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/manage_discussions/discussions.html", # lint-amnesty, pylint: disable=line-too-long
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you intend to use the settings you defined in common.py here, instead of hard-coding these URLs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Definitely!

cms/envs/common.py
DISCUSSIONS_INCONTEXT_LEARNMORE_URL = ''
# pylint: disable=line-too-long
DISCUSSIONS_INCONTEXT_FEEDBACK_URL = "https://discuss.openedx.org/t/new-and-improved-discussions-forum/9183"
DISCUSSIONS_INCONTEXT_LEARNMORE_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/manage_discussions/discussions.html"
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this default to an openedx.readthedocs url instead of an edx.readthedocs URL?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

openedx.readthedocs shows a 404. I found this doc withopenedx instead of edx but the migration_wip in the link indicates it is still a work in progress.

If you have a link with openedx, please share.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see what you're saying. I guess the openedx docs aren't ready for this yet.

cms/envs/common.py Outdated
DISCUSSIONS_INCONTEXT_FEEDBACK_URL = ''
DISCUSSIONS_INCONTEXT_LEARNMORE_URL = ''
# pylint: disable=line-too-long
DISCUSSIONS_INCONTEXT_FEEDBACK_URL = "https://discuss.openedx.org/t/new-and-improved-discussions-forum/9183"
Copy link
Contributor

Choose a reason for hiding this comment

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

These feedback URLs often lead to disappointing experiences for our users. It would be better to have them default to empty and then operators who are investing in a feedback loop can override as they like.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review @pdpinch.
I made them default to empty, as per your suggestion.

@CefBoud CefBoud force-pushed the cef/set-links-for-course-authoring-alert branch 2 times, most recently from ffd54de to 52c0f59 Compare September 4, 2024 14:48
pdpinch
pdpinch requested changes Sep 6, 2024
View reviewed changes
Copy link
Contributor

@pdpinch pdpinch left a comment

Choose a reason for hiding this comment

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

one more request

cms/envs/common.py
@@ -2814,8 +2814,9 @@

BRAZE_COURSE_ENROLLMENT_CANVAS_ID = ''

# pylint: disable=line-too-long
DISCUSSIONS_INCONTEXT_FEEDBACK_URL = ''
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm disappointed that these settings aren't annotated as required by OEP-17.

I know this predates this PR, but can you add some appropriate annotations?

@CefBoud CefBoud force-pushed the cef/set-links-for-course-authoring-alert branch from 52c0f59 to fcd774a Compare September 6, 2024 19:30
@CefBoud CefBoud requested a review from pdpinch September 7, 2024 15:12
@pdpinch
Copy link
Contributor

pdpinch commented Sep 9, 2024

nitpick: you have a typo in the commit message. It should be:

feat: set links for CourseAuthoring discussion alert

@CefBoud CefBoud force-pushed the cef/set-links-for-course-authoring-alert branch from fcd774a to 7336471 Compare September 9, 2024 13:43
@CefBoud CefBoud changed the title feat: set links for CourseAuthoring dicussion alert feat: set links for CourseAuthoring discussion alert Sep 9, 2024
@CefBoud
Copy link
Contributor Author

CefBoud commented Sep 9, 2024

Good catch! Fixed.

pdpinch
pdpinch approved these changes Sep 23, 2024
View reviewed changes
Copy link
Contributor

@pdpinch pdpinch left a comment

Choose a reason for hiding this comment

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

Do you need me to merge this for you?

@CefBoud
Copy link
Contributor Author

CefBoud commented Sep 23, 2024

@pdpinch Yes. Please take care of the merge.

@pdpinch pdpinch merged commit fe80a1c into openedx:master Sep 26, 2024
49 checks passed
@pdpinch
Copy link
Contributor

pdpinch commented Sep 26, 2024

Thank you for your contribution @CefBoud. My apologies for the delay in merging.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@itsjeyd itsjeyd removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pdpinch pdpinch pdpinch approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@CefBoud @openedx-webhooks @pdpinch @edx-pipeline-bot @itsjeyd @mphilbrick211