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

docs: Release Notes for Quince #441

Merged
merged 22 commits into from
Dec 12, 2023
Merged

docs: Release Notes for Quince #441

Changes from 19 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
c321e1a
docs: Release Notes for Quince
feoh Nov 30, 2023
578b362
docs: Fix ReStructuredText syntax errors.
feoh Nov 30, 2023
e5822f1
docs: Add more features I think might be relevant
feoh Dec 4, 2023
2e635a6
docs: Updates in response to excellent PR feedback
feoh Dec 5, 2023
e07a986
docs: Fix rst syntax errors.
feoh Dec 5, 2023
0d08498
docs: Fix one unlabeled link I missed
feoh Dec 5, 2023
9dbcf1d
docs: Try putting a whitespace before <
feoh Dec 5, 2023
1df19b5
Update source/community/release_notes/quince.rst
feoh Dec 6, 2023
7fc8bce
Update source/community/release_notes/quince.rst
feoh Dec 6, 2023
5ab418a
Update source/community/release_notes/quince.rst
feoh Dec 6, 2023
c678f10
Update source/community/release_notes/quince.rst
feoh Dec 6, 2023
af02001
docs: PR feedback
feoh Dec 6, 2023
0eddbcc
docs: Add changed Docker requirements
feoh Dec 9, 2023
41b67db
docs: Add new copy/paste feature in studio
feoh Dec 9, 2023
f4e8aab
docs: fix RST format for new feature
feoh Dec 9, 2023
e91ab72
docs: Add in unit discussions sidebar feature
feoh Dec 11, 2023
f1f6d05
docs: I put the new sidebar feature in the wrong spot
feoh Dec 11, 2023
c09beb5
docs: correct copy and paste feature link and caption
feoh Dec 11, 2023
0fbc7ed
docs: Add tutor credentials plugin feature
feoh Dec 11, 2023
a4e1e91
docs: latest round of PR feedback
feoh Dec 11, 2023
b93d406
docs: latest round of PR feedback - fix link and newline
feoh Dec 11, 2023
fe6e78b
docs: Fix a bad search/replace regex
feoh Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 130 additions & 2 deletions source/community/release_notes/quince.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _Open edX Quince Release:

Open edX Quince Release
#######################

Expand All @@ -15,26 +13,156 @@ These are the release notes for the Quince release, the 17th community release o
Breaking Changes
****************

* `Include and enable the Indigo theme in the default Open edX image <https://github.com/overhangio/tutor/issues/953>`__
* Deployers running OpenEdX with the default theme and no additional plugins will have the Indigo theme enabled automatically.
* `Deployers must ensure that for all of their IDAs, any JWT_PUBLIC_SIGNING_JWK_SET Django setting does not contain whitespace inside of the Base64 strings of the encoded keys <https://github.com/openedx/edx-drf-extensions/blob/master/CHANGELOG.rst#880---2023-05-16>`__
* Django-storages upgraded to latest version and it has some breaking changes.
* The constructor kwarg bucket is no longer accepted. Instead, use bucket_name.
* define default_acl value explicitly in constructor kwarg e.g default_acl: public-read. in previous versions django-storages provides default value as public-read but now it is none. So it's important to mention it explicitly as per your use case.
* For Django 4.2 CSRF_TRUSTED_ORIGINS must include scheme. Update all urls there with schemes. e.g .edx.org changes to ``https://*.edx.org``.
feoh marked this conversation as resolved.
Show resolved Hide resolved
* Docker requirements have changed: They are now: Docker v24.0.5+, with BuildKit 0.11+.

Learner Experiences
*******************

* `feat: fetch program subscription details <https://github.com/openedx/edx-platform/pull/32023>`__
* `In Unit Discussion Sidebar for Learners <https://partners.edx.org/announcements/discussion-sidebar-release>`__
feoh marked this conversation as resolved.
Show resolved Hide resolved


Instructor Experiences
**********************

* `Copy and Paste For Course Content <https://docs.openedx.org/en/open-release-quince.master/educators/how-tos/copy_paste_course_content.html>`__

Administrators & Operators
feoh marked this conversation as resolved.
Show resolved Hide resolved
**************************

New Learner Home Page
==================================

No longer experimental, the new Learner Home has many of the same features as the old learner dashboard, with some extended functionality and
performance enhancements.

* The Learner Home is now built with Paragon, the Open edX design pattern library. It is accessible and easy to style with brand colors.
* Course cards show the course thumbnail, information about the course, and the ability to upgrade to a paid track or view/begin a course (if applicable). Further course actions (e.g. unenroll, email opt-out settings, and social media share) have been moved to the menu/triple dot icon on the course card.
* Clicking the “Refine” button opens options to filter by course status or sort either by most recent enrollment (default) or title.

.. image:: /_images/community/release_notes/palm/new_learner_home_filtering.png
:alt: The Refine pop-up with Course State and Sort options

* All of a user’s courses are fetched on page load. To make the page manageable, we paginate that list, showing 25 courses at a time. To view other courses, a user should page through their list of courses using the pagination controls at the bottom of the course list.

.. image:: /_images/community/release_notes/palm/new_learner_home_pagination.png
:alt: Next, previous and page number buttons appear below the list of courses

* Site staff can now masquerade as users on the platform by typing a username or email in the “View as” box and hitting submit. This is designed to be “view only” so change actions (e.g. enroll, unenroll, selecting a session) are blocked in this view.
* There is a complete list of changes in the `Open edX wiki <https://openedx.atlassian.net/wiki/spaces/OEPM/blog/2022/11/21/3584589831/2U+New+Learner+Home+Page#Comparison-with-old-experience>`_.
* `feat: feature flag to disable Advanced Settings <https://github.com/openedx/edx-platform/pull/32015>`__
* `Tutor Credentials Plugin offers an admin panel where user can do configurations for the certificates of courses and programs. <https://github.com/overhangio/tutor-credentials>`__


feoh marked this conversation as resolved.
Show resolved Hide resolved
New Settings:

* `EXAMS_DASHBOARD_MICROFRONTEND_URL <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/envs/common.py#L4992>`__
* `ELASTIC_SEARCH_INDEX_PREFIX <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/envs/common.py#L1410>`__

New Waffle Flags:

* `CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATS <https://github.com/openedx/edxplatform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/xmodule/course_block.py#L61>`__
feoh marked this conversation as resolved.
Show resolved Hide resolved
* `SHOW_REGISTRATION_LINKS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/envs/common.py#L782>`__
* `IGNORED_ERRORS[N]['LOG_ERROR'S <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/openedx/core/lib/request_utils.py#L162>`__
* `IGNORED_ERRORS[N]['LOG_STACK_TRACE'S <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/openedx/core/lib/request_utils.py#L162>`__
* `SEND_CERTIFICATE_CREATED_SIGNAS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/djangoapps/certificates/config.py#L20>`__
* `SEND_CERTIFICATE_REVOKED_SIGNAS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/djangoapps/certificates/config.py#L33>`__
* `TPA_AUTOMATIC_LOGOUT_ENABLES <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/envs/common.py#L1263>`__
* `content_tagging.autS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/openedx/core/djangoapps/content_tagging/toggles.py#L8>`__
* `contentstore.default_enable_flexible_peer_openassessmentS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L519>`__
* `contentstore.enable_copy_paste_unitS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L201>`__
* `contentstore.enable_studio_content_apS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L217>`__
* `contentstore.mock_video_uploadS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L500>`__
* `contentstore.new_studio_mfe.use_new_advanced_settings_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L300>`__
* `contentstore.new_studio_mfe.use_new_course_outline_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L300>`__
* `contentstore.new_studio_mfe.use_new_course_team_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L480>`__
* `contentstore.new_studio_mfe.use_new_custom_pageS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L260>`__
* `contentstore.new_studio_mfe.use_new_export_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L380>`__
* `contentstore.new_studio_mfe.use_new_files_uploads_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L400>`__
* `contentstore.new_studio_mfe.use_new_grading_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L320>`__
* `contentstore.new_studio_mfe.use_new_import_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L360>`__
* `contentstore.new_studio_mfe.use_new_schedule_details_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L280>`__
* `contentstore.new_studio_mfe.use_new_unit_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L460>`__
* `contentstore.new_studio_mfe.use_new_updates_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L340>`__
* `contentstore.new_studio_mfe.use_new_video_uploads_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L420>`__
* `course_experience.relative_dates_disable_reseS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/openedx/features/course_experience/__init__.py#L55>`__
* `course_home.course_home_mfe_progress_taS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/djangoapps/course_home_api/toggles.py#L9>`__
* `courseware.learning_assistanS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/djangoapps/courseware/toggles.py#L112>`__
* `courseware.mfe_courseware_searcS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/djangoapps/courseware/toggles.py#L58>`__
* `learner_dashboard.enable_b2c_subscriptionS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/lms/djangoapps/learner_dashboard/config/waffle.py#L41>`__
* `new_core_editors.use_video_gallery_floS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L125>`__
* `new_editors.add_game_block_buttoS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L162>`__
* `new_studio_mfe.use_new_home_pagS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/cms/djangoapps/contentstore/toggles.py#L241>`__
* `notifications.enable_notificationS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/openedx/core/djangoapps/notifications/config/waffle.py#L10>`__
* `notifications.show_notifications_traS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/openedx/core/djangoapps/notifications/config/waffle.py#L21>`__
* `xblocks.xblock_skill_tag_verificatioS <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/xmodule/vertical_block.py#L38>`__

feoh marked this conversation as resolved.
Show resolved Hide resolved
Removed Waffle Flags:

* BLOCK_STRUCTURES_SETTINGS['PRUNING_ACTIVE']
* EXPECTED_ERRORS[N]['IS_IGNORED']
* EXPECTED_ERRORS[N]['LOG_ERROR']
* EXPECTED_ERRORS[N]['LOG_STACK_TRACE']
* block_structure.invalidate_cache_on_publish
* contentstore.enable_copy_paste_feature
* learner_home_mfe.enable_learner_home_amplitude_recommendations
* registration.enable_failure_logging


Deprecations & Removals
feoh marked this conversation as resolved.
Show resolved Hide resolved
***********************

* `We have deprecated and migrated the openedx/xblock-utils library into openedx/XBlock <https://github.com/openedx/XBlock/issues/675>`__

* `Most functionality has been removed from the long-deprecated Old Mongo Modulestore. For more details, please <https://github.com/openedx/public-engineering/issues/62>`__

* `BasicAuthentication as default authentication class in edx-platform <https://github.com/openedx/edx-platform/issues/33028>`__

* `Remove JWT_AUTH_REFRESH_COOKIE: <https://github.com/openedx/public-engineering/issues/190>`__

* `feat: allow for forcing asymmetric jwts <https://github.com/openedx/edx-platform/pull/32045>`__

* `[DEPR]: Expected error part of EXPECTED_ERRORS <https://github.com/openedx/edx-platform/issues/32405>`__

* `[DEPR]: Expected error part of EXPECTED_ERRORS <https://github.com/openedx/public-engineering/issues/190>`__

* `[DEPR]: Remove JWT_AUTH_REFRESH_COOKIE - only in credentialS <https://github.com/openedx/credentials/issues/1989>`__

* `Remove bok-choy usagS <https://github.com/openedx/public-engineering/issues/31>`__

* `[DEPR]: BLOCK_STRUCTURES_SETTINGS['PRUNING_ACTIVE'] in edx-platforS <https://github.com/openedx/edx-platform/issues/33028>`__

* `[DEPR]: BasicAuthentication as default authentication class in edx-platforS <https://github.com/openedx/public-engineering/issues/213>`__

* `[DEPR]: Removal of Deprecated and unused feature flags from Mobile-Config RepS <https://github.com/openedx/public-engineering/issues/167>`__

* `[DEPR]: edx-user-state-client repS <https://github.com/openedx-unsupported/AnimationXBlock/issues/88>`__

* `[DEPR]: AnimationXBlocS <https://github.com/openedx/public-engineering/issues/33>`__

* `[DEPR]: block_structure.invalidate_cache_on_publish in edx-platforS <https://github.com/openedx/public-engineering/issues/200>`__

* `[DEPR]: edx-sphinx-theme <https://github.com/openedx/edx-platform/issues/32683>`__

* `[DEPR]: paver update_dS <https://github.com/openedx/public-engineering/issues/52>`__

* `[DEPR]: Remove FOOTER_ORGANIZATION_IMAGE django settingS <https://github.com/openedx/public-engineering/issues/84>`__

* `[DEPR]: registration.enable_failure_logginS <https://github.com/openedx/public-engineering/issues/84>`__


Developer Experience
********************

* `Hostname migration: local.overhang.io -> local.edly.io <https://github.com/overhangio/tutor/issues/945>`__
* This should only effect plugin maintainers.

Researcher & Data Experiences
*****************************
feoh marked this conversation as resolved.
Show resolved Hide resolved
Expand Down