feat!: hide courses in /courses based on catalog visibility #35646
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @regisb! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf 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 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
|
|
Previously, courses were always displayed on the LMS /courses page,
independently of their catalog visibility attribute. This meant that
even with visibility="none" courses were being displayed. This was very
counter-intuitive.
With this change, courses are displayed only when their visibility is
set to "both".
This change is flagged as breaking because it has the potential to
affect course catalogs in existing platforms.
To test this change, go to http(s)://LMS/courses as an anonymous user.
Pick a visible course and go to its "advanced settings" in the studio.
Set "Course visibility in catalog" to "about" or "none". Then, clear the
cache with the following command:
./manage.py lms shell -c "from django.core.cache import cache; cache.clear()"
Open the /courses page again: the course should no longer be visible.
Close openedx/wg-build-test-release#330
regisb
force-pushed
the
regisb/course-visibility
branch
from
c308fb4 to
5c4cf7a
Compare
|
This PR is ready for review @openedx/wg-maintenance-edx-platform. Discussion whether this warrants a product proposal is happening here: openedx/wg-build-test-release#330 (comment) |
|
Ah the rebase will work automatically so I can merge it! |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
Oh wow that was fast, thanks a lot Sarina! |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
Description
Previously, courses were always displayed on the LMS /courses page, independently of their catalog visibility attribute. This meant that even with visibility="none" courses were being displayed. This was very counter-intuitive.
With this change, courses are displayed only when their visibility is set to "both".
This change is flagged as breaking because it has the potential to affect course catalogs in existing platforms.
Supporting information
Close openedx/wg-build-test-release#330
Testing instructions
To test this change, go to http(s)://LMS/courses as an anonymous user. Pick a visible course and go to its "advanced settings" in the studio. Set "Course visibility in catalog" to "about" or "none". Then, clear the cache with the following command:
Open the /courses page again: the course should no longer be visible.
Deadline
This PR probably comes too late for redwood.3. Hopefully we can merge it in time for sumac.1. If the sumac branch is cut before this PR is merged, then we should backport this change to the sumac branch.