Sumac Release Notes #622
+95
−6
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,19 +18,53 @@ Breaking Changes | |
| **************** | ||
|
|
||
|
|
||
| User Facing Experiences | ||
| ************************* | ||
|
|
||
| See the :doc:`feature_release_notes` for more detail on user-facing changes in this release. | ||
|
|
||
|
|
||
| Administrators & Operators | ||
| ************************** | ||
|
|
||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Most search functionality included in the core platform now supports Meilisearch as an alternative to Elasticsearch. For instances deployed using Tutor, only Meilisearch is supported, and Tutor will automatically provision Meilisearch and create the indexes during the upgrade. | ||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - After upgrading, if you wish to use the new Content Libraries (beta) or Studio Course Search features, you will need to run ``manage.py cms reindex_studio --experimental --incremental`` to populate the new Studio Search index with your existing content (courseware/libraries). Studio search results will be incomplete until this command has finished. | ||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - `Course assets are now served by a view rather than a middleware <https://github.com/openedx/edx-platform/issues/34702>`_ | ||
| - Background: The LMS/CMS previously handled course asset requests (asset-v1: andc4x URLs) via a middleware called StaticContentServer. This middleware has been converted to a view. | ||
| - Action: If your deployment has a custom MIDDLEWARE list in Django, you will need to remove this item at the time of upgrade to Sumac. Otherwise, no action is needed. | ||
| - Ubuntu 22.04 Related Operators Note | ||
| - `PR <https://github.com/openedx/edx-platform/pull/35450>`_ | ||
| - In newer versions of ubuntu the MD4 hashing algorithm is disabled by default. To enable it the openssl config needs to be updated in a manner similar to what's being done here. Alternatively, you can set the FEATURES['ENABLE_BLAKE2B_HASHING'] setting to True which will switch to a newer hashing algorithm where MD4 was previously used. | ||
| Because this hashing is being used as a part of the edx-platform caching mechanism, this will effectively clear the cache for the items that use this hash. The will impact any items where the cache key might have been too big to store in memcache so it's hard to predict exactly which items will be impacted. | ||
| - Added override options to commerce related CTA URLs in edx-platform | ||
| - Background: Extension points have been added have been added to commerce app in: `PR1 <https://github.com/openedx/edx-platform/pull/35441>`_, `PR2 <https://github.com/openedx/edx-platform/pull/35501>`_ so Open edX community members who wants to extend the commerce functionality can do so without explicitly adding code into edx-platform codebase. For more information into extension points see Pluggable override section in `Extension Points <https://github.com/openedx/edx-platform/blob/master/docs/concepts/extension_points.rst>`_. | ||
| - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. | ||
|
There was a problem hiding this comment. Link to DEPR ticket would be good There was a problem hiding this comment. @sarina Thanks! Whose cage should I politely rattle to figure out which DEPR to link here please? :) There was a problem hiding this comment. The original DEPR was here: openedx/public-engineering#22 There is not one yet for the commerce app which we'll likely leave in for a bit longer. There was a problem hiding this comment. @feanil @sarina I'm super confused about how to handle this. The current block says: Where do I link that DEPR in? And do I just delete the "Additional Considerations" bullet? Signed, |
||
| - `courseware.enable_navigation_sidebar <https://github.com/openedx/edx-platform/blob/38f73442e78a8b9afb5543facd170dca830acb1a/lms/djangoapps/courseware/toggles.py#L86>`_ is now enabled by default. It was disabled by default in Redwood. | ||
|
|
||
| - New Forums Implementation (migration from Ruby to Python forums backend) | ||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - For users running Tutor, they will automatically switch to the new app. Instructions to migrate data from mongodb to mysql is available in the plugin README https://github.com/overhangio/tutor-forum/ (not yet merged, see `feat: upgrade to sumac <https://github.com/overhangio/tutor-forum/pull/49/files>`_). | ||
|
|
||
| - Users not running Tutor will by default remain on the legacy `cs_comments_service` app. They need to read this part of the forum app README: https://github.com/openedx/forum?tab=readme-ov-file#forum-v2-toggle Some settings need to be defined even for legacy app users. | ||
|
|
||
|
|
||
| Settings and Toggles | ||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ==================== | ||
| - `contentstore.new_studio_mfe.disable_legacy_libraries <https://github.com/openedx/edx-platform/blob/2c575209f1177f095860a89b0c0ac080db9442a1/cms/djangoapps/contentstore/toggles.py#L613>`_ | ||
| - `contentstore.new_studio_mfe.disable_new_libraries <https://github.com/openedx/edx-platform/blob/2c575209f1177f095860a89b0c0ac080db9442a1/cms/djangoapps/contentstore/toggles.py#L641C1-L641C2>`_ | ||
| - `DISABLED_COUNTRIES <https://github.com/openedx/edx-platform/blob/b07464ba2dc4e397af799e40effd2e267516ea2a/cms/envs/common.py#L2956>`_ | ||
| - `GRADEBOOK_FREEZE_DAYS <https://github.com/openedx/edx-platform/blob/b07464ba2dc4e397af799e40effd2e267516ea2a/lms/envs/common.py#L1098>`_ | ||
| - `XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE <https://github.com/openedx/edx-platform/blob/b07464ba2dc4e397af799e40effd2e267516ea2a/cms/envs/common.py#L1034>`_ | ||
| - `course_experience.enable_ses_for_goalreminder <https://github.com/openedx/edx-platform/blob/dafcac780ae96a2ca93a2dc94425d3a3e27bbc83/openedx/features/course_experience/__init__.py#L37>`_ | ||
| - `discounts.enable_first_purchase_discount_override <https://github.com/openedx/edx-platform/blob/dafcac780ae96a2ca93a2dc94425d3a3e27bbc83/openedx/features/discounts/applicability.py#L32>`_ | ||
| - `new_core_editors.use_advanced_problem_editor <https://github.com/openedx/edx-platform/blob/dafcac780ae96a2ca93a2dc94425d3a3e27bbc83/cms/djangoapps/contentstore/toggles.py#L163>`_ | ||
| - `notifications.enable_new_notification_view <https://github.com/openedx/edx-platform/blob/dafcac780ae96a2ca93a2dc94425d3a3e27bbc83/openedx/core/djangoapps/notifications/config/waffle.py#L53>`_ | ||
| - `notifications.enable_notification_grouping <https://github.com/openedx/edx-platform/blob/dafcac780ae96a2ca93a2dc94425d3a3e27bbc83/openedx/core/djangoapps/notifications/config/waffle.py#L42C19-L42C61>`_ | ||
| - `notifications.enable_ora_grade_notifications <https://github.com/openedx/edx-platform/blob/dafcac780ae96a2ca93a2dc94425d3a3e27bbc83/openedx/core/djangoapps/notifications/config/waffle.py#L40>`_ | ||
| - `ENABLE_ORA_PEER_CONFIGURABLE_GRADING <https://github.com/openedx/edx-ora2/blob/5ce41562e7b874856c541a20eb8288880628b3f0/openassessment/xblock/config_mixin.py#L186-L198>`_ | ||
| - `RBAC_IGNORE_INVALID_JWT_COOKIE <https://github.com/openedx/edx-rbac/blob/b354112ff24181ceb7ca660db493b5a03d62f808/edx_rbac/constants.py#L7-L16>`_ | ||
| - `enterprise.enterprise_customer_support_tool <https://github.com/openedx/edx-enterprise/blob/7ca07317c5dc05ab70b83451144192a0e1c4162f/enterprise/toggles.py#L46-L56>`_ | ||
| - `enterprise.enterprise_groups_v2 <https://github.com/openedx/edx-enterprise/blob/7ca07317c5dc05ab70b83451144192a0e1c4162f/enterprise/toggles.py#L58-L68>`_ | ||
|
|
||
|
|
||
| Other Operator Changes | ||
|
|
@@ -40,10 +74,24 @@ Other Operator Changes | |
| Deprecations & Removals | ||
| *********************** | ||
|
|
||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - The existing "Content Libraries" feature has been renamed to "Legacy Libraries" and will be deprecated in the next release (Teak), and removed entirely in Ulmo in favor of the new "Content Libraries" feature. The Teak release will include a tool for migrating content from Legacy Libraries into new Content Libraries. | ||
| - In `frontend-app-learner-dashboard <https://github.com/openedx/frontend-app-learner-dashboard>`_ | ||
| - support for Optimizely has been removed along with the ProductRecommendations widget. | ||
| - `DEPR: Optimizely Support <https://github.com/openedx/frontend-app-learner-dashboard/issues/387>`_ | ||
| - Removed the RecommendationsPanel widget | ||
| - `DEPR: RecommendationsPanel <https://github.com/openedx/frontend-app-learner-dashboard/issues/410>`_ | ||
| - In edx-platform: | ||
| - ``commerce-coordinator`` related code has been removed | ||
| - `PR: <https://github.com/openedx/edx-platform/pull/35527>`_ | ||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [UPCOMING] In Teak pre-design-tokens brand packages will no longer be supported. With design tokens, theme authors will instead override core Paragon tokens by defining their own JSON tokens that get deep merged alongside the core Paragon tokens, thus overriding any tokens that were defined by the theme author. See `the associated DEPR ticket for details <https://github.com/openedx/brand-openedx/issues/23>`_. | ||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - The cs_comments_service application is being replaced by forum. `[DEPR]: Replace cs_comments_service #437 <https://github.com/openedx/cs_comments_service/issues/437>`_ | ||
| - The Zooming Image Tool will be deprecated in Sumac. `[DEPR] Zooming Image Tool (HTML block template) #31436 <https://github.com/openedx/edx-platform/issues/31436>`_ | ||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Developer Experience | ||
| ******************** | ||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - With the launch of the new Content Libraries feature, many new or updated APIs are now ready for developers to start using (though some are in beta and may change). This includes the entire `Learning Core API <https://github.com/openedx/openedx-learning/blob/main/openedx_learning/api/authoring.py>`_ (Components, Contents, Publishing, Collections), `Content Tagging API <https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/content_tagging/api.py>`_, `Content Libraries API <https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/content_libraries/api.py>`_, and `Learning Core XBlock API <https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/xblock/api.py>`_. Most of these APIs (other than tagging) are only useful in content libraries at the moment, but when courseware is eventually moved to Learning Core as well, the Learning Core APIs will be recommended way to work with all learning content in the platform, and the modulestore APIs will be deprecated. | ||
|
|
||
| Researcher & Data Experiences | ||
sarina marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ***************************** | ||
|
|
||
feoh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add this line IF it is true, because otherwise reading the rendered page it's a bit unclear how the headers nest. But I want to check in on this - @arbrandes @bradenmacdonald @regisb @feanil - no breaking changes in Sumac? Who else should I tag?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ormsbee or @kdmccormick ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@feoh I didn't mean for you to commit this at this time. We need to check if there are any breaking changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Crap itchy trigger finger. Unresolving. Will fix if people find breaking changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know, I'm sorry :) I'll fix it if people raise anything but I'm not going to create a revision to fix a thing which in fact may not be broken :) I'll stay on top of this and ensure the page reflects reality. Sorry for prematurely pulling the trigger!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is atleast openedx/edx-platform#35185 which should be captured here as a breaking change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@feanil That PR is not included in Sumac as far as I can tell.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, you're right, it was merged just after. Right in that case, I think there is nothing that I'm aware of that's breaking in Sumac.