From f551b190387c026a535a3ba3b7f47b2e1d0b7681 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Wed, 30 Oct 2024 22:19:29 -0400 Subject: [PATCH 01/37] feat: Preliminary cut of Sumac release notes. Incomplete. Currently missing waffle flags for this release and likely much else :) --- .../sumac/dev_op_release_notes.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 3e271d044..147216976 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -29,6 +29,17 @@ Instructor Experiences Administrators & Operators ************************** +- `Course assets should be served by a view rather than a middleware `_ + - 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 `_ + - 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 `_, `PR2 ` so openedX 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 `_. + - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. + Settings and Toggles ==================== @@ -40,6 +51,14 @@ Other Operator Changes Deprecations & Removals *********************** +- In `frontend-app-learner-dashboard `_ + - support for Optimizely has been removed along with the ProductRecommendations widget. + - `DEPR: Optimizely Support `_ + - Removed the RecommendationsPanel widget + - `DEPR: RecommendationsPanel `_ +- In edx-platform: + - ``commerce-coordinator`` related code has been removed + - `PR: `_ Developer Experience ******************** From e305eebdd2ddf32aabdaeffdf2e3ece068ac7e80 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Fri, 22 Nov 2024 16:42:49 -0500 Subject: [PATCH 02/37] docs: initial cut of release notes for OpenEdX Sumac https://github.com/openedx/wg-build-test-release/issues/398 --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 147216976..afc052e9c 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -42,6 +42,8 @@ Administrators & Operators Settings and Toggles ==================== +- `contentstore.new_studio_mfe.disable_legacy_libraries `_ +- `contentstore.new_studio_mfe.disable_new_libraries `_ Other Operator Changes From 0cbdc8f7a2bf072e7391d41f351253189bcaa8e5 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 3 Dec 2024 15:05:51 -0500 Subject: [PATCH 03/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index afc052e9c..3055b6397 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -61,7 +61,7 @@ Deprecations & Removals - In edx-platform: - ``commerce-coordinator`` related code has been removed - `PR: `_ - +- [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 `_. Developer Experience ******************** From c8d76fa15a14af65aa2c015449eb88bf0e46316d Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 3 Dec 2024 16:56:27 -0500 Subject: [PATCH 04/37] docs: Add note about newly enabled by default sidebar toggle. --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 3055b6397..063f785bb 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -39,6 +39,7 @@ Administrators & Operators - 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 `_, `PR2 ` so openedX 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 `_. - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. + - `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. Settings and Toggles ==================== From a6ba69c1c39f094f240bb030f40c8a241ea49e10 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Fri, 6 Dec 2024 17:27:03 -0500 Subject: [PATCH 05/37] docs: Added new settings for Sumac. (Still need to add feature toggles). --- source/community/release_notes/sumac/dev_op_release_notes.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 063f785bb..68fe90e67 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -45,6 +45,9 @@ Settings and Toggles ==================== - `contentstore.new_studio_mfe.disable_legacy_libraries `_ - `contentstore.new_studio_mfe.disable_new_libraries `_ +- `DISABLED_COUNTRIES `_ +- `GRADEBOOK_FREEZE_DAYS `_ +- `XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE `_ Other Operator Changes From 8862dc936090da3a5be2931ac7f8fbcc782a682d Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 9 Dec 2024 18:25:23 -0500 Subject: [PATCH 06/37] docs: Add most feature toggles --- .../release_notes/sumac/dev_op_release_notes.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 68fe90e67..e03d4011b 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -48,6 +48,14 @@ Settings and Toggles - `DISABLED_COUNTRIES `_ - `GRADEBOOK_FREEZE_DAYS `_ - `XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE `_ +- `contentstore.new_studio_mfe.disable_legacy_libraries `_ +- `contentstore.new_studio_mfe.disable_new_libraries `_ +- `discounts.enable_first_purchase_discount_override `_ +- `new_core_editors.use_advanced_problem_editor `_ +- `notifications.enable_new_notification_view `_ +- `notifications.enable_notification_grouping `_ +- `notifications.enable_ora_grade_notifications `_ Other Operator Changes From d647d80779c5aebd2b8f3a47de4e15f4d17e4fec Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 13:45:38 -0500 Subject: [PATCH 07/37] docs: Add missing feature flags from other repos. Also incproproate PR feedback. --- .../release_notes/sumac/dev_op_release_notes.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index e03d4011b..53f0afd70 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -41,6 +41,10 @@ Administrators & Operators - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. - `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. +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 this PR). + +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 ==================== - `contentstore.new_studio_mfe.disable_legacy_libraries `_ @@ -48,14 +52,16 @@ Settings and Toggles - `DISABLED_COUNTRIES `_ - `GRADEBOOK_FREEZE_DAYS `_ - `XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE `_ -- `contentstore.new_studio_mfe.disable_legacy_libraries `_ -- `contentstore.new_studio_mfe.disable_new_libraries `_ - `discounts.enable_first_purchase_discount_override `_ - `new_core_editors.use_advanced_problem_editor `_ - `notifications.enable_new_notification_view `_ - `notifications.enable_notification_grouping `_ - `notifications.enable_ora_grade_notifications `_ +- `ENABLE_ORA_PEER_CONFIGURABLE_GRADING `_ +- `RBAC_IGNORE_INVALID_JWT_COOKIE `_ +- `enterprise.enterprise_customer_support_tool `_ +- `enterprise.enterprise_groups_v2 `_ Other Operator Changes @@ -74,6 +80,8 @@ Deprecations & Removals - ``commerce-coordinator`` related code has been removed - `PR: `_ - [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 `_. +- the cs_comments_service application is being replaced by forum. `[DEPR]: Replace cs_comments_service #437 `_ + Developer Experience ******************** From 484412b11034486814f424d3636733ae7a7f3e57 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 14:05:34 -0500 Subject: [PATCH 08/37] docs: Add zooming image tool DEPR --- source/community/release_notes/sumac/dev_op_release_notes.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 53f0afd70..4e72bab86 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -80,7 +80,8 @@ Deprecations & Removals - ``commerce-coordinator`` related code has been removed - `PR: `_ - [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 `_. -- the cs_comments_service application is being replaced by forum. `[DEPR]: Replace cs_comments_service #437 `_ +- The cs_comments_service application is being replaced by forum. `[DEPR]: Replace cs_comments_service #437 `_ +- The Zooming Image Tool will be deprecated in Sumac. `[DEPR] Zooming Image Tool (HTML block template) #31436 `_ Developer Experience ******************** From fb062a11c7cc64fd4f164183d624968a6c4a48e5 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 14:08:12 -0500 Subject: [PATCH 09/37] docs: Add blank line to trigger Sphinx rebuild --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 4e72bab86..6ffc88f26 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -45,6 +45,7 @@ For users running Tutor, they will automatically switch to the new app. Instruct 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 ==================== - `contentstore.new_studio_mfe.disable_legacy_libraries `_ From a094d097e0d5e3862dadb90ed53f96e7b9a1736b Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 16:03:27 -0500 Subject: [PATCH 10/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Great informational additions on Mellisearch and indexing/upgrades. Thank you! Co-authored-by: Braden MacDonald --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 6ffc88f26..b15b36101 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -29,6 +29,8 @@ Instructor Experiences Administrators & Operators ************************** +- 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. + - After upgrading, you 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. - `Course assets should be served by a view rather than a middleware `_ - 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.. From 01efc6b476e73bb261a201bae66d86484cd83239 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 16:04:01 -0500 Subject: [PATCH 11/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Naming changes. Thank you! Co-authored-by: Braden MacDonald --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index b15b36101..b402d418d 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -74,6 +74,7 @@ Other Operator Changes Deprecations & Removals *********************** +- The existing "Content Libraries" feature has been renamed to "Legacy Libraries" and will be deprecated in the next release (Teak), and removed entirely in release after Teak 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 `_ - support for Optimizely has been removed along with the ProductRecommendations widget. - `DEPR: Optimizely Support `_ From c64064ee05012df1311023803eac642030ba9460 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 16:04:34 -0500 Subject: [PATCH 12/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Content libraries info updates. Thank you! Co-authored-by: Braden MacDonald --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index b402d418d..963d9d57c 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -90,6 +90,8 @@ Deprecations & Removals Developer Experience ******************** +- 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 `_ (Components, Contents, Publishing, Collections), `Content Tagging API `_, `Content Libraries API `_, and `Learning Core XBlock API `_. 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 ***************************** From 4bbeb8f0c20913853a7508c590c7234a155a7420 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 16:33:15 -0500 Subject: [PATCH 13/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Braden MacDonald --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 963d9d57c..f6d58d8b7 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -30,7 +30,7 @@ Administrators & Operators ************************** - 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. - - After upgrading, you 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. + - After upgrading, you 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. - `Course assets should be served by a view rather than a middleware `_ - 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.. From 74b9f4be59c31f78f82b0ee03414e905cc8d872d Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 18:28:13 -0500 Subject: [PATCH 14/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index f6d58d8b7..d79e1e07b 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -33,7 +33,7 @@ Administrators & Operators - After upgrading, you 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. - `Course assets should be served by a view rather than a middleware `_ - 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.. + - 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 `_ - 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. From 61c1cc6c473a141b9e475b5520f07d7020b07544 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 18:28:51 -0500 Subject: [PATCH 15/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index d79e1e07b..0c720b3b9 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -31,7 +31,7 @@ Administrators & Operators - 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. - After upgrading, you 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. -- `Course assets should be served by a view rather than a middleware `_ +- `Course assets are now served by a view rather than a middleware `_ - 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 From 44263cabe7687383bf53a3d6fa64a47bd1ddc953 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 18:29:05 -0500 Subject: [PATCH 16/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 0c720b3b9..b328945ee 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -38,7 +38,7 @@ Administrators & Operators - `PR `_ - 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 +- 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 `_, `PR2 ` so openedX 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 `_. - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. - `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. From 0dc610647a71229f1b8aace5b44dd1ad9de9487a Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 18:29:28 -0500 Subject: [PATCH 17/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index b328945ee..ddd81f3ce 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -74,7 +74,7 @@ Other Operator Changes Deprecations & Removals *********************** -- The existing "Content Libraries" feature has been renamed to "Legacy Libraries" and will be deprecated in the next release (Teak), and removed entirely in release after Teak 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. +- 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 `_ - support for Optimizely has been removed along with the ProductRecommendations widget. - `DEPR: Optimizely Support `_ From d917c51327ea22fbfcf73e823a4a6840d026d4b1 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 18:29:49 -0500 Subject: [PATCH 18/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index ddd81f3ce..96f9b029c 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -43,6 +43,7 @@ Administrators & Operators - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. - `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. +- New Forums Implementation (migration from Ruby to Python forums backend) 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 this PR). 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. From 52ce181eb2252fe47504bfd6f46cc4515642dc61 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 20:54:03 -0500 Subject: [PATCH 19/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Yay less Ruby more Python :) Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 96f9b029c..bc14cc866 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -44,6 +44,7 @@ Administrators & Operators - `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. - New Forums Implementation (migration from Ruby to Python forums backend) + 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 this PR). 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. From ae099ce9ddaf28eb9a71875db3ebbbcf400a0ac5 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 20:54:32 -0500 Subject: [PATCH 20/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Verbage correction. Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index bc14cc866..cd7f00879 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -30,7 +30,7 @@ Administrators & Operators ************************** - 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. - - After upgrading, you 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. + - 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. - `Course assets are now served by a view rather than a middleware `_ - 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. From 2f7c1f9b8fa8706869ce7b89256ac0729563bdca Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 20:55:50 -0500 Subject: [PATCH 21/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Yay less MongoDB and more MySQL! Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index cd7f00879..7af663c07 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -45,7 +45,7 @@ Administrators & Operators - New Forums Implementation (migration from Ruby to Python forums backend) -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 this PR). + - 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 this PR). 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. From c0529562ca07e494f1de474eb3b8fa455c141a17 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 10 Dec 2024 20:56:09 -0500 Subject: [PATCH 22/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst clarification. Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 7af663c07..f6307cfec 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -47,7 +47,7 @@ Administrators & Operators - 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 this PR). -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. + - 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 From 7effbb6ebbae812806cc9b743a1b73b1f8e14657 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Wed, 11 Dec 2024 12:32:09 -0500 Subject: [PATCH 23/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Good extension points info. Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index f6307cfec..a213be9f2 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -39,7 +39,7 @@ Administrators & Operators - 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 `_, `PR2 ` so openedX 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 `_. + - Background: Extension points have been added have been added to commerce app in: `PR1 `_, `PR2 `_ 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 `_. - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. - `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. From f7c0429f3bd91d7fc3c2ff9d63367a7fbf00ba38 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Wed, 11 Dec 2024 12:32:57 -0500 Subject: [PATCH 24/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Whitespace fix. Thank you! Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index a213be9f2..e0056b36c 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -41,7 +41,7 @@ Administrators & Operators - 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 `_, `PR2 `_ 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 `_. - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. - - `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. +- `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. - New Forums Implementation (migration from Ruby to Python forums backend) From fc9f81ce0a3ddfc0bf7bd886ee144d11722ab576 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Wed, 11 Dec 2024 12:38:31 -0500 Subject: [PATCH 25/37] docs: Add link to Sumac upgrade feature PR. --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index e0056b36c..ef97c6a0e 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -45,7 +45,7 @@ Administrators & Operators - New Forums Implementation (migration from Ruby to Python forums backend) - - 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 this PR). + - 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 `_). - 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. From cca982ac5ceb627f8290ed1711190f371259f9dc Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Wed, 11 Dec 2024 12:45:59 -0500 Subject: [PATCH 26/37] docs: Make Sabrina suggested category consolidation --- .../release_notes/sumac/dev_op_release_notes.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index ef97c6a0e..b4605fb23 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -18,12 +18,10 @@ Breaking Changes **************** -Learner Experiences -******************* +User Facing Experiences +************************* - -Instructor Experiences -********************** +See the :doc:`feature_release_notes` for more detail on user-facing changes in this release. Administrators & Operators From 970b2c87c4604177abcb9458addd1ba73cfe38d8 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Wed, 11 Dec 2024 13:00:39 -0500 Subject: [PATCH 27/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Yay no breaking changes! Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index b4605fb23..30fbba1c2 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -17,6 +17,8 @@ To view the end-user facing docs, see the :doc:`feature_release_notes`. Breaking Changes **************** +No breaking changes in Sumac. + User Facing Experiences ************************* From aa5abb40aa36d434353a80a78be2584a25c6f325 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Wed, 11 Dec 2024 13:32:35 -0500 Subject: [PATCH 28/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Disambiguate Mellisearch as a requirement. Co-authored-by: Braden MacDonald --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 30fbba1c2..5d9058db0 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -30,6 +30,7 @@ Administrators & Operators ************************** - 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. + - Two recent features, Studio Course Search and the new Content Libraries (beta), require Meilisearch and will be hidden from the UI if Meilisearch is not available. (For the Content Libraries beta, this affects only the UI - developers can still use the APIs without Meilisearch.) - 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. - `Course assets are now served by a view rather than a middleware `_ - 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. From 96968dc8793027968a702da338b5a86b519e39b4 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 12 Dec 2024 09:32:54 -0500 Subject: [PATCH 29/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Improved Aspects instructions. Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 5d9058db0..716b37035 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -98,6 +98,7 @@ Developer Experience Researcher & Data Experiences ***************************** +Upgrading Aspects to v1.3.1 will get you the latest Aspects functionality with Sumac. `See the upgrade instructions here `_. Known Issues ************ From a1056a1b2971cb757ffe75e40d29bcf812a11d01 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 12 Dec 2024 09:44:44 -0500 Subject: [PATCH 30/37] docs: Add removed toggles as per review feedback. --- .../sumac/dev_op_release_notes.rst | 27 +++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 716b37035..2484a4850 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -51,8 +51,8 @@ Administrators & Operators - 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 -==================== +New And Updated Settings and Toggles +==================================== - `contentstore.new_studio_mfe.disable_legacy_libraries `_ - `contentstore.new_studio_mfe.disable_new_libraries `_ - `DISABLED_COUNTRIES `_ @@ -69,6 +69,29 @@ Settings and Toggles - `enterprise.enterprise_customer_support_tool `_ - `enterprise.enterprise_groups_v2 `_ +Removed Settings and Toggles +============================ +COURSEGRAPH_DUMP_COURSE_ON_PUBLISH +FEATURESENABLE_LIBRARY_AUTHORING_MICROFRONTEND +FEATURESENABLE_V2_CERT_DISPLAY_SETTINGS +commerce.transition_to_coordinator.checkout +commerce.transition_to_coordinator.refund +contentstore.library_authoring_mfe +discussions.enable_reported_content_notifications +learner_dashboard.enable_b2c_subscriptions +notifications.enable_coursewide_notifications +notifications.enable_notifications_filters +notifications.enable_ora_staff_notifications +notifications.show_notifications_tray +studio.enable_course_update_notifications +BLOCKSTORE_BUNDLE_CACHE_TIMEOUT +BUNDLE_ASSET_STORAGE_SETTINGS +BUNDLE_ASSET_URL_STORAGE_KEY +BUNDLE_ASSET_URL_STORAGE_SECRET +BLOCKSTORE_BUNDLE_CACHE_TIMEOUT +COURSEGRAPH_CONNECTION +COURSEGRAPH_JOB_QUEUE + Other Operator Changes ====================== From 111cd503f75a1dc2523f7d044124c1b96be47a0f Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 12 Dec 2024 10:45:06 -0500 Subject: [PATCH 31/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: David Ormsbee --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 2484a4850..062069141 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -32,6 +32,7 @@ Administrators & Operators - 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. - Two recent features, Studio Course Search and the new Content Libraries (beta), require Meilisearch and will be hidden from the UI if Meilisearch is not available. (For the Content Libraries beta, this affects only the UI - developers can still use the APIs without Meilisearch.) - 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. + - A new media storage setting is required for new Content Libraries. This should be specified as `OPENEDX_LEARNING['MEDIA']`. Tutor will [provide this setting automatically](https://github.com/overhangio/tutor/blob/33d2bc2c71e3cd30545417afb18ba2bd989a19fd/tutor/templates/apps/openedx/settings/partials/common_all.py#L251-L258), and can be used as an example for those who are running different infrastructure. For those not running Tutor, _please ensure that the file storage location is not publicly accessible_. - `Course assets are now served by a view rather than a middleware `_ - 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. From 3dec30baf493eb927fd12c6251cf717836cddfda Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 12 Dec 2024 11:10:35 -0500 Subject: [PATCH 32/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: David Ormsbee --- source/community/release_notes/sumac/dev_op_release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 062069141..5a121839c 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -31,6 +31,7 @@ Administrators & Operators - 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. - Two recent features, Studio Course Search and the new Content Libraries (beta), require Meilisearch and will be hidden from the UI if Meilisearch is not available. (For the Content Libraries beta, this affects only the UI - developers can still use the APIs without Meilisearch.) + - The new Content Libraries (beta) can be hidden entirely in Sumac by setting the waffle flag ``contentstore.new_studio_mfe.disable_new_libraries`` to "Yes". This option will be removed in Teak. - 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. - A new media storage setting is required for new Content Libraries. This should be specified as `OPENEDX_LEARNING['MEDIA']`. Tutor will [provide this setting automatically](https://github.com/overhangio/tutor/blob/33d2bc2c71e3cd30545417afb18ba2bd989a19fd/tutor/templates/apps/openedx/settings/partials/common_all.py#L251-L258), and can be used as an example for those who are running different infrastructure. For those not running Tutor, _please ensure that the file storage location is not publicly accessible_. - `Course assets are now served by a view rather than a middleware `_ From 2d130d924bf02b54ada4ba0ccb72d3b1649a0295 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 12 Dec 2024 15:18:39 -0500 Subject: [PATCH 33/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Peter Pinch --- source/community/release_notes/sumac/dev_op_release_notes.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 5a121839c..c862a4d0a 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -109,8 +109,7 @@ Deprecations & Removals - Removed the RecommendationsPanel widget - `DEPR: RecommendationsPanel `_ - In edx-platform: - - ``commerce-coordinator`` related code has been removed - - `PR: `_ + - ``commerce-coordinator`` related code has been removed. `PR: `_ - [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 `_. - The cs_comments_service application is being replaced by forum. `[DEPR]: Replace cs_comments_service #437 `_ - The Zooming Image Tool will be deprecated in Sumac. `[DEPR] Zooming Image Tool (HTML block template) #31436 `_ From 450c28a4dabb26a9fbe1b416022fd26ce120c9ca Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 12 Dec 2024 16:51:16 -0500 Subject: [PATCH 34/37] docs: Add DEPR meeting results from Peter and fix RST bogons. --- .../release_notes/sumac/dev_op_release_notes.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index c862a4d0a..309e3ed3c 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -33,7 +33,7 @@ Administrators & Operators - Two recent features, Studio Course Search and the new Content Libraries (beta), require Meilisearch and will be hidden from the UI if Meilisearch is not available. (For the Content Libraries beta, this affects only the UI - developers can still use the APIs without Meilisearch.) - The new Content Libraries (beta) can be hidden entirely in Sumac by setting the waffle flag ``contentstore.new_studio_mfe.disable_new_libraries`` to "Yes". This option will be removed in Teak. - 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. - - A new media storage setting is required for new Content Libraries. This should be specified as `OPENEDX_LEARNING['MEDIA']`. Tutor will [provide this setting automatically](https://github.com/overhangio/tutor/blob/33d2bc2c71e3cd30545417afb18ba2bd989a19fd/tutor/templates/apps/openedx/settings/partials/common_all.py#L251-L258), and can be used as an example for those who are running different infrastructure. For those not running Tutor, _please ensure that the file storage location is not publicly accessible_. + - A new media storage setting is required for new Content Libraries. This should be specified as OPENEDX_LEARNING['MEDIA']. Tutor will `provide this setting automatically `_, and can be used as an example for those who are running different infrastructure. For those not running Tutor, **please ensure that the file storage location is not publicly accessible**. - `Course assets are now served by a view rather than a middleware `_ - 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. @@ -111,8 +111,21 @@ Deprecations & Removals - In edx-platform: - ``commerce-coordinator`` related code has been removed. `PR: `_ - [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 `_. +- [UPCOMING] Between now and the release of Teak, all Dockerfiles will be removed from the Open edX organization. As an alternative, Tutor provides `production-ready Docker images `_ for all supported Open edX services. And each Open edX service repository should contain documentation describing how it can be installed and executed, allowing anyone to write a Dockerfile that provisions the repository. See `this associated DEPR ticket for details `_. - The cs_comments_service application is being replaced by forum. `[DEPR]: Replace cs_comments_service #437 `_ - The Zooming Image Tool will be deprecated in Sumac. `[DEPR] Zooming Image Tool (HTML block template) #31436 `_ +- The EdxRestApiClient has been deprecated and removed in this release. See `[DEPR]: Complete removal of `EdxRestApiClient `_ for details. +- The Demographics app has been removed. It was added to support a private edX Demographics IDA for collecting additional user info. See `[DEPR]: Demographics Django app #35127 `_. +- The programs_listing endpoint in the credentials application has been removed. `[DEPR]: /program-listing endpoint `_. +- The skill_level endpoint has been removed `[DEPR]: endpoint /user/v1/skill_level/{job_id}/ `_. +- [UPCOMING] The Toggle 'block_structure.storage_backing_for_cache' will be removed, with a default setting of True. You may want to test enabling in Sumac before it becomes the default behavior in Teak. See `[DEPR]: block_structure.storage_backing_for_cache in edx-platform `_. +- As part of the `Oscare Ecommerce Stack deprecation `_ , the following repositories have been archived: + - https://github.com/openedx/ecommerce + - https://github.com/openedx/ecommerce-worker + - https://github.com/openedx/frontend-app-payment + - https://github.com/openedx/frontend-app-ecommerce + - https://github.com/openedx/ecommerce-scripts + Developer Experience ******************** From 8d338344a2ae6cd29fe47f20ee2d85c86995a123 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Sat, 14 Dec 2024 22:01:31 -0500 Subject: [PATCH 35/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index 309e3ed3c..b25d98198 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -43,7 +43,7 @@ Administrators & Operators 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 `_, `PR2 `_ 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 `_. - - Additional Considerations: Commerce app itself is slated for deprecation nevertheless. + - Additional Considerations: Commerce app itself is slated for deprecation. `See the associated DEPR ticket `_. - `courseware.enable_navigation_sidebar `_ is now enabled by default. It was disabled by default in Redwood. - New Forums Implementation (migration from Ruby to Python forums backend) From ea216beb6c7e2376ce2d3caf11c512bbe9268b5e Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 16 Dec 2024 12:55:56 -0500 Subject: [PATCH 36/37] docs: fix release dates --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index b25d98198..a56a48265 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -3,7 +3,7 @@ Open edX Sumac Developer & Operator Release Notes These are the developer & operator release notes for the Sumac release, the 19th community release of the Open edX Platform, spanning changes from May 10, 2024 -to October 23, 2024. You can also review details about :doc:`../index` or learn +to November 5th, 2024. You can also review details about :doc:`../index` or learn more about the `Open edX Platform`_. To view the end-user facing docs, see the :doc:`feature_release_notes`. From 13a0ba9881ed76395fe87d2691acdb7c7cf34a1d Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 16 Dec 2024 13:24:55 -0500 Subject: [PATCH 37/37] Update source/community/release_notes/sumac/dev_op_release_notes.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac/dev_op_release_notes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index a56a48265..7452bd536 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -19,6 +19,8 @@ Breaking Changes No breaking changes in Sumac. +No breaking changes in Sumac. + User Facing Experiences *************************