From 95d7d99a31208c4eae3cffb8cdfd306f8f3bb158 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 13 Jun 2024 17:12:01 -0400 Subject: [PATCH 01/56] docs: Redwood release notes first cut. Necessary changes for the OpenEdX Redwood release. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/index.rst | 4 +- .../community/release_notes/old_releases.rst | 1 + source/community/release_notes/redwood.rst | 171 ++++++++++++++++++ source/index.rst | 2 +- 4 files changed, 175 insertions(+), 3 deletions(-) diff --git a/source/community/release_notes/index.rst b/source/community/release_notes/index.rst index 2a9b6368..e491d80d 100755 --- a/source/community/release_notes/index.rst +++ b/source/community/release_notes/index.rst @@ -11,7 +11,7 @@ The *Open edX Platform Release Notes* provide information about releases, migrat .. toctree:: :maxdepth: 2 - Redwood: The next release - Quince: The current release + Redwood: The current release + Sumac: The next release named_release_branches_and_tags old_releases diff --git a/source/community/release_notes/old_releases.rst b/source/community/release_notes/old_releases.rst index 1b0a8ea4..7b411c25 100644 --- a/source/community/release_notes/old_releases.rst +++ b/source/community/release_notes/old_releases.rst @@ -11,6 +11,7 @@ fixes and features. These older releases will not receive any of those. .. toctree:: :maxdepth: 2 + quince palm olive nutmeg diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index eda81b03..1f1eb03c 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -13,6 +13,47 @@ These are the release notes for the Redwood release, the 18th community release Breaking Changes **************** +- Deployers must ensure that their + ``JWT_AUTH['JWT_PRIVATE_SIGNING_JWK']`` Django setting in LMS + contains the full complement of private key numbers.* + + - **Background:**\ *In LMS, we are switching from the pyjwkest + library to PyJWT for signing JWTs. (pyjwkest is now unmaintained.) + However, PyJWT has stricter requirements for the private key in + ``JWT_PRIVATE_SIGNING_JWK``. Before you upgrade to Redwood, you + will need to update this key using a script. Otherwise, JWT + signing will fail, and users will be unable to log in.* + + - **Steps:** + + 1. Locate ``JWT_PRIVATE_SIGNING_JWK`` in your deployment + configuration.* + + 2. Check if the JSON contains all of the following params: ``p``, + ``q``, ``dp``, ``dq``, and ``qi``. If it does, you don’t need + to do anything further. Otherwise, continue.* + + 3. In your edx-platform virtualenv, run + ``python3 scripts/jwk-precompute-params.py`` and follow the + prompts. (It will ask you to paste in the current JSON.)* + + 4. Update your config’s ``JWT_AUTH['JWT_PRIVATE_SIGNING_JWK']`` + with the output of the script.* + + 5. You may wish to compare the contents of the private key before + and after running the script, and verify that the only changes + it has made to the contents of the JSON are that the ``p``, + ``q``, ``dp``, ``dq``, and ``qi`` params have been added. (Some + or all may already have been present.)* + + - **Notes:** + + 1. This should be done while you are still running Quince—it is + safe to do ahead of the upgrade, and should not have any + visible effect at that time.* + + 2. This key must be handled very carefully. Anyone in possession + of the key may impersonate users.* Learner Experiences ******************* @@ -25,10 +66,140 @@ Instructor Experiences Administrators & Operators ************************** +Settings and Toggles +==================== + +Waffle flags: + +`contentstore.new_studio_mfe.use_new_advanced_settings_page `_ +`contentstore.new_studio_mfe.use_new_certificates_page `_ +`contentstore.new_studio_mfe.use_new_course_outline_page `_ +`contentstore.new_studio_mfe.use_new_course_team_page `_ +`contentstore.new_studio_mfe.use_new_custom_pages `_ +`contentstore.new_studio_mfe.use_new_export_page `_ +`contentstore.new_studio_mfe.use_new_files_uploads_page `_ +`contentstore.new_studio_mfe.use_new_grading_page `_ +`contentstore.new_studio_mfe.use_new_group_configurations_page `_ +`contentstore.new_studio_mfe.use_new_import_page `_ +`contentstore.new_studio_mfe.use_new_schedule_details_page `_ +`contentstore.new_studio_mfe.use_new_textbooks_page `_ +`contentstore.new_studio_mfe.use_new_unit_page (disabled) `_ +`contentstore.new_studio_mfe.use_new_updates_page `_ +`contentstore.new_studio_mfe.use_new_video_uploads_page (disabled) `_ +`new_studio_mfe.use_new_home_page `_ + +Course authoring MFE config: + +ENABLE_UNIT_PAGE: "false" +ENABLE_NEW_EDITOR_PAGES: "true" +ENABLE_TAGGING_TAXONOMY_PAGES: "true" +ENABLE_ASSETS_PAGE: "true" +ENABLE_HOME_PAGE_COURSE_API_V2: "true" + +Other Operator Changes +====================== + +- The default minimum password length has been updated from 2 + characters to 8 characters. `(PR) `_. + + - If you have an existing password, this change along will not + force you to update it. However if you reset your password or go + to change it, you'll have to conform to the new guidelines. If you + would like to force people to update their password, you'll + probably want to take a look at .. _the password_policy plugin and its settings: https://github.com/openedx/edx-platform/blob/2033dcf6ace133719aaeb72dc5dd6ee521a7ac42/openedx/core/djangoapps/password_policy/settings/common.py#L13 .* + +- The following `requirements update `_ into credentials might have implications for anyone + who has a massive ``usersocialauth`` table.  This is because that + table grows endlessly, and the migrations on the table caused by + updating the ``social-auth-app-django`` package can run out of + memory. If maintainers have migration failures on this upgrade, they + should run the management command `truncate_social_auth `_.* + + - This will remove all entries from the ``usersocialauth`` table + that haven't been updated in 90 days, which makes the size of the + table tractable for the dependency's migration. This is harmless + in the ``Credentials`` IDA.* + +- The scripts related to user retirement across all services + have been moved to the ``edx-platform`` repository. If you’ve been + using the \`tubular repo to run retirement scripts you should update + your code.* + + - *Relevant Tickets* + - `Move user retirement code to edx-platform and drop it from Tubular `_. + - `Move user retirement scripts code from the tubular repo `_. + - `Deprecate User Retirement Scripts `_. + +- *edx-platform and cs_comment_service Mongo Upgrades* + - `chore: add mongo 7 to testing matrix `_. + - `build: Build with newer ruby and mongo versions. `_. + +- The Redwood release includes the `Studio Course Search [BETA] `_, which is disabled by default + as it depends on a new search engine, Meilisearch. We encourage + operators to install Meilisearch, test out this feature, and give us + feedback on the viability of using Meilisearch as a replacement for + Elasticsearch in future releases of Open edX. Here’s how:* + + - For tutor-based deployments, install the `tutor-contrib-mailsearch `_ plugin, and apply the + changes to your deployment. See that plugin’s README for details. + Note in particular that the hostname configured as + ``MEILISEARCH_PUBLIC_HOST`` must be resolvable on the public + internet.* + + - If you are not using Tutor, you’ll need to install Meilisearch + manually (or use the cloud product), and to explicitly set `the related config variables `_ in the + CMS as well as set ``MEILISEARCH_ENABLED=true`` in the Course + Authoring MFE settings.* + + - To create and populate the search index, you must run a one-time + command from the CMS shell: + ``python manage.py cms reindex_studio --experimental``. This + command may take a while if you have a lot of courses and/or + libraries in Studio; it will display regular progress indicators + while it is running. We are interested in hearing how long it + takes for you - please share your experience (see next bullet). + This command reads from MySQL/MongoDB but does not write to them; + it only writes to Meilisearch. Once the indexing has completed, it + should not be necessary to run it again; from that point forward, + the indexes will be updated automatically as needed.* + + - Please share your feedback about Meilisearch, indexing, and + operations in `this Discourse thread `_ or the `#ops `_ Slack channel. Please share feedback about + the new course search feature in general `in the discussion forums `_ or in the `#wg-product-core `_ Slack channel.* + Deprecations & Removals *********************** +- *Badges app has been deprecated and removed from ``edx-platform``. + See `[DEPR]: lms/djangoapps/badges `_ .* + + - *``accomplishments_shared`` field is removed from payloads and + settings* + + - *``ENABLE_OPENBADGES`` is no longer available for configuration in + ``FEATURES``* + + - *``BADGING_BACKEND``, ``BADGR_BASE_URL``, ``BADGR_ISSUER_SLUG``, + ``BADGR_USERNAME``, ``BADGR_PASSWORD``, + ``BADGR_TOKENS_CACHE_KEY``, ``BADGR_TIMEOUT``, + ``BADGR_ENABLE_NOTIFICATIONS`` are also not configurable anymore.* + +- * In edxapp, the Waffle switch ``ip.legacy`` is removed. See `[DEPR]: legacy_ip code and Waffle switch `_ .* + + - *Any deployment that has been relying on this legacy IP address + option will need to switch to setting + ``CLOSEST_CLIENT_IP_FROM_HEADERS`` appropriately. See `Nutmeg Announcement `_ for + details.* + +- *Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac* + - `[DEPR]: Asset processing in Paver `_. + - *This should cover everything that a site operator needs to do as a part of deployment.* + - *Non deployment paver commands will be removed by Sumac* + +- *The django-splash capability was removed from edx-platform and the + relevant code has been archived.* + - https://github.com/openedx/public-engineering/issues/224 Developer Experience ******************** diff --git a/source/index.rst b/source/index.rst index c54ccef4..b585dfeb 100644 --- a/source/index.rst +++ b/source/index.rst @@ -43,7 +43,7 @@ Open edX Documentation :maxdepth: 1 :caption: Open Source Community - Current Release: Quince + Current Release: Redwood All Release Notes How to Contribute OEPs (Open edX Proposals): Community Decision Documents From 14f6f80683e2d998f52a144074eca381e448b858 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 13 Jun 2024 17:22:15 -0400 Subject: [PATCH 02/56] docs: Include stub sumac release notes. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/sumac.rst | 48 ++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100755 source/community/release_notes/sumac.rst diff --git a/source/community/release_notes/sumac.rst b/source/community/release_notes/sumac.rst new file mode 100755 index 00000000..80d10ffc --- /dev/null +++ b/source/community/release_notes/sumac.rst @@ -0,0 +1,48 @@ +Open edX Sumac Release +######################## + +These are the release notes for the Sumac release, the 19th community release of the Open edX Platform, spanning changes from MONTH DAY 2024 to MONTH DAY 2024. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_. + +.. _earlier releases: https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/named_releases.html +.. _Open edX Platform: https://openedx.org + +.. contents:: + :depth: 1 + :local: + +Breaking Changes +**************** + + +Learner Experiences +******************* + + +Instructor Experiences +********************** + + +Administrators & Operators +************************** + +Settings and Toggles +==================== + + +Other Operator Changes +====================== + + +Deprecations & Removals +*********************** + + +Developer Experience +******************** + +Researcher & Data Experiences +***************************** + + +Known Issues +************ From 3ed3ab6709f1a4763e44041ed752ad786210f26a Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Thu, 13 Jun 2024 20:14:15 -0400 Subject: [PATCH 03/56] docs: Remove unneeded italc and incorrect line end Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 1f1eb03c..05993689 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -17,43 +17,43 @@ Breaking Changes ``JWT_AUTH['JWT_PRIVATE_SIGNING_JWK']`` Django setting in LMS contains the full complement of private key numbers.* - - **Background:**\ *In LMS, we are switching from the pyjwkest + - Background: In LMS, we switched from the pyjwkest library to PyJWT for signing JWTs. (pyjwkest is now unmaintained.) However, PyJWT has stricter requirements for the private key in ``JWT_PRIVATE_SIGNING_JWK``. Before you upgrade to Redwood, you will need to update this key using a script. Otherwise, JWT - signing will fail, and users will be unable to log in.* + signing will fail, and users will be unable to log in. - - **Steps:** + - Steps: 1. Locate ``JWT_PRIVATE_SIGNING_JWK`` in your deployment - configuration.* + configuration. 2. Check if the JSON contains all of the following params: ``p``, ``q``, ``dp``, ``dq``, and ``qi``. If it does, you don’t need - to do anything further. Otherwise, continue.* + to do anything further. Otherwise, continue. 3. In your edx-platform virtualenv, run ``python3 scripts/jwk-precompute-params.py`` and follow the - prompts. (It will ask you to paste in the current JSON.)* + prompts. (It will ask you to paste in the current JSON.) 4. Update your config’s ``JWT_AUTH['JWT_PRIVATE_SIGNING_JWK']`` - with the output of the script.* + with the output of the script. 5. You may wish to compare the contents of the private key before and after running the script, and verify that the only changes it has made to the contents of the JSON are that the ``p``, ``q``, ``dp``, ``dq``, and ``qi`` params have been added. (Some - or all may already have been present.)* + or all may already have been present.) - - **Notes:** + - Notes: 1. This should be done while you are still running Quince—it is safe to do ahead of the upgrade, and should not have any - visible effect at that time.* + visible effect at that time. 2. This key must be handled very carefully. Anyone in possession - of the key may impersonate users.* + of the key may impersonate users. Learner Experiences ******************* From 592411641c808d99686b4fd2578d86b65f479e53 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Fri, 14 Jun 2024 11:18:41 -0400 Subject: [PATCH 04/56] Update source/community/release_notes/redwood.rst Co-authored-by: Peter Pinch --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 05993689..a8f394d2 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -102,7 +102,7 @@ Other Operator Changes - The default minimum password length has been updated from 2 characters to 8 characters. `(PR) `_. - - If you have an existing password, this change along will not + - If you have an existing password, this change alone will not force you to update it. However if you reset your password or go to change it, you'll have to conform to the new guidelines. If you would like to force people to update their password, you'll From 568c718e64be1ec05e63afe1157d8304b7e45a46 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Fri, 14 Jun 2024 11:18:59 -0400 Subject: [PATCH 05/56] Update source/community/release_notes/redwood.rst Co-authored-by: Peter Pinch --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index a8f394d2..a5bb38a6 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -106,7 +106,7 @@ Other Operator Changes force you to update it. However if you reset your password or go to change it, you'll have to conform to the new guidelines. If you would like to force people to update their password, you'll - probably want to take a look at .. _the password_policy plugin and its settings: https://github.com/openedx/edx-platform/blob/2033dcf6ace133719aaeb72dc5dd6ee521a7ac42/openedx/core/djangoapps/password_policy/settings/common.py#L13 .* + probably want to take a look at `the password_policy plugin and its settings `_ - The following `requirements update `_ into credentials might have implications for anyone who has a massive ``usersocialauth`` table.  This is because that From 0c69d3a59df22426491d0e80782e09f8baca11b4 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Fri, 14 Jun 2024 11:20:11 -0400 Subject: [PATCH 06/56] Update source/community/release_notes/redwood.rst Co-authored-by: Peter Pinch --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index a5bb38a6..9e5885ac 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -122,7 +122,7 @@ Other Operator Changes - The scripts related to user retirement across all services have been moved to the ``edx-platform`` repository. If you’ve been - using the \`tubular repo to run retirement scripts you should update + using the tubular repo to run retirement scripts you should update your code.* - *Relevant Tickets* From 4f109291db86ab28146f4d4bf3dc997e70c9479b Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Fri, 14 Jun 2024 14:28:00 -0400 Subject: [PATCH 07/56] docs: Threw out my guessed toggles and used Marias Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 68 ++++++++++++++-------- 1 file changed, 45 insertions(+), 23 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 9e5885ac..4ec32cb6 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -69,32 +69,54 @@ Administrators & Operators Settings and Toggles ==================== -Waffle flags: - -`contentstore.new_studio_mfe.use_new_advanced_settings_page `_ +Waffle flags Added In Redwood: + +`ANONYMOUS_SURVEY_REPORT `_ +`ENFORCE_SESSION_EMAIL_MATCH `_ +`FEATURES['ENABLE_BLAKE2B_HASHING'] `_ +`FEATURES['ENABLE_CERTIFICATES_INSTRUCTOR_MANAGE] `_ +`FEATURES['ENABLE_COURSEWARE_SEARCH_VERIFIED_REQUIRED'] `_ +`FEATURES['ENABLE_GRADING_METHOD_IN_PROBLEMS'] - LMS `_ +`FEATURES['ENABLE_GRADING_METHOD_IN_PROBLEMS'] - CMS `_ +`FEATURES['ENABLE_HIDE_FROM_TOC_UI'] `_ +`FEATURES['ENABLE_HOME_PAGE_COURSE_API_V2'] `_ +`FEATURES['ENABLE_LTI_PII_ACKNOWLEDGEMENT'] `_ +`FEATURES['ENABLE_SEND_XBLOCK_LIFECYCLE_EVENTS_OVER_BUS'] `_ +`FEATURES['SEND_LEARNING_CERTIFICATE_LIFECYCLE_EVENTS_TO_BUS'] `_ +`JWT_AUTH_ADD_KID_HEADER: `_ +`SURVEY_REPORT_ENABLE `_ +`agreements.enable_lti_pii_acknowledgement `_ +`commerce.transition_to_coordinator.checkout `_ +`commerce.transition_to_coordinator.refund `_ +`content_tagging.disabled `_ `contentstore.new_studio_mfe.use_new_certificates_page `_ -`contentstore.new_studio_mfe.use_new_course_outline_page `_ -`contentstore.new_studio_mfe.use_new_course_team_page `_ -`contentstore.new_studio_mfe.use_new_custom_pages `_ -`contentstore.new_studio_mfe.use_new_export_page `_ -`contentstore.new_studio_mfe.use_new_files_uploads_page `_ -`contentstore.new_studio_mfe.use_new_grading_page `_ `contentstore.new_studio_mfe.use_new_group_configurations_page `_ -`contentstore.new_studio_mfe.use_new_import_page `_ -`contentstore.new_studio_mfe.use_new_schedule_details_page `_ `contentstore.new_studio_mfe.use_new_textbooks_page `_ -`contentstore.new_studio_mfe.use_new_unit_page (disabled) `_ -`contentstore.new_studio_mfe.use_new_updates_page `_ -`contentstore.new_studio_mfe.use_new_video_uploads_page (disabled) `_ -`new_studio_mfe.use_new_home_page `_ - -Course authoring MFE config: - -ENABLE_UNIT_PAGE: "false" -ENABLE_NEW_EDITOR_PAGES: "true" -ENABLE_TAGGING_TAXONOMY_PAGES: "true" -ENABLE_ASSETS_PAGE: "true" -ENABLE_HOME_PAGE_COURSE_API_V2: "true" +`course_home.new_discussion_sidebar_view `_ +`teams.content_groups_for_teams `_ +`courseware.always_open_auxiliary_sidebar `_ +`courseware.disable_navigation_sidebar_blocks_caching `_ +`courseware.discovery_default_language_filter `_ +`courseware.enable_navigation_sidebar `_ +`discussions.enable_reported_content_notifications `_ +`notifications.enable_coursewide_notifications `_ +`notifications.enable_email_notifications `_ +`notifications.enable_notifications_filters `_ +`notifications.enable_ora_staff_notifications `_ +`student.redirect_to_courseware_after_enrollment `_ +`studio.enable_course_update_notifications `_ +`user_tours.tours_disabled `_ +`video_config.transcript_feedback `_ +`video_config.xpert_translations_ui `_ +`ENABLE_AUTO_GENERATED_USERNAME `_ +`EDX_DRF_EXTENSIONS[ENABLE_JWT_AND_LMS_USER_EMAIL_MATCH] `_ +`FEATURES['ENABLE_ORA_SELECTABLE_LEARNER_WAITING_REVIEW'] `_ +`enterprise.enterprise_groups_v1 `_ +`enterprise.feature_prequery_search_suggestions `_ +`EVENT_BUS_PRODUCER_CONFIG['org.openedx.content_authoring.course.catalog_info.changed.v1'] `_ +`EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.course.unenrollment.completed.v1'] `_ +`EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.xblock.skill.verified.v1'] `_ + Other Operator Changes ====================== From b07c8a10f1fd36e1394634bba6b312b8c01e70c9 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Fri, 14 Jun 2024 14:39:38 -0400 Subject: [PATCH 08/56] docs: Add studio mfe issue to breaking changes and add known issues board link under known issues subhead. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 4ec32cb6..0956525e 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -55,6 +55,15 @@ Breaking Changes 2. This key must be handled very carefully. Anyone in possession of the key may impersonate users. +- `studio_home.enable_global_staff_optimization flag no longer works in Studio MFE `_ + - Background: Basically, this flag worked for the legacy Studio Home, improving performance by + adding an organization search bar. But as the report mentions, it's not working + correctly in the Studio Home MFE. The good thing is that this flag is not needed + in the Studio Home MFE since we already have a search bar and pagination, which + improves performance for those home pages with lots of courses. I wouldn't consider + it a "breaking change" but a known issue for those who want to turn on the Studio + Home MFE and are using the flag. + Learner Experiences ******************* @@ -232,3 +241,5 @@ Researcher & Data Experiences Known Issues ************ + +Please refer to `this board `_ for known issues with Redwood. From 3f03069eeb77262235ea4a8209eea7ed810b4b3d Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 16:45:22 -0400 Subject: [PATCH 09/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 0956525e..a7704b8c 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -15,7 +15,7 @@ Breaking Changes - Deployers must ensure that their ``JWT_AUTH['JWT_PRIVATE_SIGNING_JWK']`` Django setting in LMS - contains the full complement of private key numbers.* + contains the full complement of private key ``numbers.*`` - Background: In LMS, we switched from the pyjwkest library to PyJWT for signing JWTs. (pyjwkest is now unmaintained.) From c415a99c76f0f5fcfc445404f1aba5b22653e64c Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 16:49:38 -0400 Subject: [PATCH 10/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index a7704b8c..24c497c7 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -64,7 +64,10 @@ Breaking Changes it a "breaking change" but a known issue for those who want to turn on the Studio Home MFE and are using the flag. -Learner Experiences +Learner & Instructor Experiences +********************************* + +See the Product Release Notes. ******************* From 2d0e5a227bad6e5f9bc7b9bfd9a079932d476065 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 16:49:56 -0400 Subject: [PATCH 11/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 24c497c7..6134aa4d 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -81,7 +81,7 @@ Administrators & Operators Settings and Toggles ==================== -Waffle flags Added In Redwood: +Waffle flags added In Redwood: `ANONYMOUS_SURVEY_REPORT `_ `ENFORCE_SESSION_EMAIL_MATCH `_ From c91eaae87b50d5e29be3cbcaf5e4f7eba0fc7420 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 16:52:04 -0400 Subject: [PATCH 12/56] Update source/community/release_notes/sumac.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac.rst b/source/community/release_notes/sumac.rst index 80d10ffc..a2953b92 100755 --- a/source/community/release_notes/sumac.rst +++ b/source/community/release_notes/sumac.rst @@ -1,5 +1,5 @@ Open edX Sumac Release -######################## +###################### These are the release notes for the Sumac release, the 19th community release of the Open edX Platform, spanning changes from MONTH DAY 2024 to MONTH DAY 2024. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_. From 80d72f7cd047746033c23b5b9c7eb8021b257eb2 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 16:52:42 -0400 Subject: [PATCH 13/56] Update source/community/release_notes/sumac.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/sumac.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/sumac.rst b/source/community/release_notes/sumac.rst index a2953b92..78a7c1e3 100755 --- a/source/community/release_notes/sumac.rst +++ b/source/community/release_notes/sumac.rst @@ -1,7 +1,7 @@ Open edX Sumac Release ###################### -These are the release notes for the Sumac release, the 19th community release of the Open edX Platform, spanning changes from MONTH DAY 2024 to MONTH DAY 2024. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_. +These are the release notes for the Sumac release, the 19th community release of the Open edX Platform, spanning changes from May 10, 2024 to October 09, 2024. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_. .. _earlier releases: https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/named_releases.html .. _Open edX Platform: https://openedx.org From 7d29b4bf707b1b1ebfbb3abf6ffa65e6e8aac288 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 17:00:31 -0400 Subject: [PATCH 14/56] docs: Add bullet list for toggles Also, fix incorrect number of stars because ReStructuredText is demonic :) Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 94 +++++++++++----------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 6134aa4d..9a4acf7e 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -65,10 +65,10 @@ Breaking Changes Home MFE and are using the flag. Learner & Instructor Experiences -********************************* +******************************** See the Product Release Notes. -******************* +****************************** Instructor Experiences @@ -83,51 +83,51 @@ Settings and Toggles Waffle flags added In Redwood: -`ANONYMOUS_SURVEY_REPORT `_ -`ENFORCE_SESSION_EMAIL_MATCH `_ -`FEATURES['ENABLE_BLAKE2B_HASHING'] `_ -`FEATURES['ENABLE_CERTIFICATES_INSTRUCTOR_MANAGE] `_ -`FEATURES['ENABLE_COURSEWARE_SEARCH_VERIFIED_REQUIRED'] `_ -`FEATURES['ENABLE_GRADING_METHOD_IN_PROBLEMS'] - LMS `_ -`FEATURES['ENABLE_GRADING_METHOD_IN_PROBLEMS'] - CMS `_ -`FEATURES['ENABLE_HIDE_FROM_TOC_UI'] `_ -`FEATURES['ENABLE_HOME_PAGE_COURSE_API_V2'] `_ -`FEATURES['ENABLE_LTI_PII_ACKNOWLEDGEMENT'] `_ -`FEATURES['ENABLE_SEND_XBLOCK_LIFECYCLE_EVENTS_OVER_BUS'] `_ -`FEATURES['SEND_LEARNING_CERTIFICATE_LIFECYCLE_EVENTS_TO_BUS'] `_ -`JWT_AUTH_ADD_KID_HEADER: `_ -`SURVEY_REPORT_ENABLE `_ -`agreements.enable_lti_pii_acknowledgement `_ -`commerce.transition_to_coordinator.checkout `_ -`commerce.transition_to_coordinator.refund `_ -`content_tagging.disabled `_ -`contentstore.new_studio_mfe.use_new_certificates_page `_ -`contentstore.new_studio_mfe.use_new_group_configurations_page `_ -`contentstore.new_studio_mfe.use_new_textbooks_page `_ -`course_home.new_discussion_sidebar_view `_ -`teams.content_groups_for_teams `_ -`courseware.always_open_auxiliary_sidebar `_ -`courseware.disable_navigation_sidebar_blocks_caching `_ -`courseware.discovery_default_language_filter `_ -`courseware.enable_navigation_sidebar `_ -`discussions.enable_reported_content_notifications `_ -`notifications.enable_coursewide_notifications `_ -`notifications.enable_email_notifications `_ -`notifications.enable_notifications_filters `_ -`notifications.enable_ora_staff_notifications `_ -`student.redirect_to_courseware_after_enrollment `_ -`studio.enable_course_update_notifications `_ -`user_tours.tours_disabled `_ -`video_config.transcript_feedback `_ -`video_config.xpert_translations_ui `_ -`ENABLE_AUTO_GENERATED_USERNAME `_ -`EDX_DRF_EXTENSIONS[ENABLE_JWT_AND_LMS_USER_EMAIL_MATCH] `_ -`FEATURES['ENABLE_ORA_SELECTABLE_LEARNER_WAITING_REVIEW'] `_ -`enterprise.enterprise_groups_v1 `_ -`enterprise.feature_prequery_search_suggestions `_ -`EVENT_BUS_PRODUCER_CONFIG['org.openedx.content_authoring.course.catalog_info.changed.v1'] `_ -`EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.course.unenrollment.completed.v1'] `_ -`EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.xblock.skill.verified.v1'] `_ +* `ANONYMOUS_SURVEY_REPORT `_ +* `ENFORCE_SESSION_EMAIL_MATCH `_ +* `FEATURES['ENABLE_BLAKE2B_HASHING'] `_ +* `FEATURES['ENABLE_CERTIFICATES_INSTRUCTOR_MANAGE] `_ +* `FEATURES['ENABLE_COURSEWARE_SEARCH_VERIFIED_REQUIRED'] `_ +* `FEATURES['ENABLE_GRADING_METHOD_IN_PROBLEMS'] - LMS `_ +* `FEATURES['ENABLE_GRADING_METHOD_IN_PROBLEMS'] - CMS `_ +* `FEATURES['ENABLE_HIDE_FROM_TOC_UI'] `_ +* `FEATURES['ENABLE_HOME_PAGE_COURSE_API_V2'] `_ +* `FEATURES['ENABLE_LTI_PII_ACKNOWLEDGEMENT'] `_ +* `FEATURES['ENABLE_SEND_XBLOCK_LIFECYCLE_EVENTS_OVER_BUS'] `_ +* `FEATURES['SEND_LEARNING_CERTIFICATE_LIFECYCLE_EVENTS_TO_BUS'] `_ +* `JWT_AUTH_ADD_KID_HEADER: `_ +* `SURVEY_REPORT_ENABLE `_ +* `agreements.enable_lti_pii_acknowledgement `_ +* `commerce.transition_to_coordinator.checkout `_ +* `commerce.transition_to_coordinator.refund `_ +* `content_tagging.disabled `_ +* `contentstore.new_studio_mfe.use_new_certificates_page `_ +* `contentstore.new_studio_mfe.use_new_group_configurations_page `_ +* `contentstore.new_studio_mfe.use_new_textbooks_page `_ +* `course_home.new_discussion_sidebar_view `_ +* `teams.content_groups_for_teams `_ +* `courseware.always_open_auxiliary_sidebar `_ +* `courseware.disable_navigation_sidebar_blocks_caching `_ +* `courseware.discovery_default_language_filter `_ +* `courseware.enable_navigation_sidebar `_ +* `discussions.enable_reported_content_notifications `_ +* `notifications.enable_coursewide_notifications `_ +* `notifications.enable_email_notifications `_ +* `notifications.enable_notifications_filters `_ +* `notifications.enable_ora_staff_notifications `_ +* `student.redirect_to_courseware_after_enrollment `_ +* `studio.enable_course_update_notifications `_ +* `user_tours.tours_disabled `_ +* `video_config.transcript_feedback `_ +* `video_config.xpert_translations_ui `_ +* `ENABLE_AUTO_GENERATED_USERNAME `_ +* `EDX_DRF_EXTENSIONS[ENABLE_JWT_AND_LMS_USER_EMAIL_MATCH] `_ +* `FEATURES['ENABLE_ORA_SELECTABLE_LEARNER_WAITING_REVIEW'] `_ +* `enterprise.enterprise_groups_v1 `_ +* `enterprise.feature_prequery_search_suggestions `_ +* `EVENT_BUS_PRODUCER_CONFIG['org.openedx.content_authoring.course.catalog_info.changed.v1'] `_ +* `EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.course.unenrollment.completed.v1'] `_ +* `EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.xblock.skill.verified.v1'] `_ Other Operator Changes From 230360ad98eca4f3a3a377a5e52b0508a1680fa0 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 17:08:25 -0400 Subject: [PATCH 15/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 9a4acf7e..ab71fdc2 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -56,7 +56,10 @@ Breaking Changes of the key may impersonate users. - `studio_home.enable_global_staff_optimization flag no longer works in Studio MFE `_ - - Background: Basically, this flag worked for the legacy Studio Home, improving performance by + - Background: This flag works for the legacy Studio Home, improving performance by + adding an organization search bar. This flag does not work in the Studio Home MFE, as it + is not needed within the MFE. The MFE already have a search bar and pagination, which + improves performance for those home pages with lots of courses. adding an organization search bar. But as the report mentions, it's not working correctly in the Studio Home MFE. The good thing is that this flag is not needed in the Studio Home MFE since we already have a search bar and pagination, which From c1536c2e163812ce9accddfb02bf4e481dce64c0 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 17:10:52 -0400 Subject: [PATCH 16/56] docs: Remove unneded text as per review comment. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index ab71fdc2..f90f300a 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -231,7 +231,6 @@ Deprecations & Removals - *Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac* - `[DEPR]: Asset processing in Paver `_. - - *This should cover everything that a site operator needs to do as a part of deployment.* - *Non deployment paver commands will be removed by Sumac* - *The django-splash capability was removed from edx-platform and the From 54b892fbbc0354f3d753007d7c2a928959a15506 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Mon, 17 Jun 2024 17:24:25 -0400 Subject: [PATCH 17/56] docs: Fix indentation problem RST was choking on. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index f90f300a..975c53e6 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -57,9 +57,9 @@ Breaking Changes - `studio_home.enable_global_staff_optimization flag no longer works in Studio MFE `_ - Background: This flag works for the legacy Studio Home, improving performance by - adding an organization search bar. This flag does not work in the Studio Home MFE, as it - is not needed within the MFE. The MFE already have a search bar and pagination, which - improves performance for those home pages with lots of courses. + adding an organization search bar. This flag does not work in the Studio Home MFE, as it + is not needed within the MFE. The MFE already have a search bar and pagination, which + improves performance for those home pages with lots of courses. adding an organization search bar. But as the report mentions, it's not working correctly in the Studio Home MFE. The good thing is that this flag is not needed in the Studio Home MFE since we already have a search bar and pagination, which From 25322900b2ea6448a4390fa09935a1c2c56b4ed3 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:50:54 -0400 Subject: [PATCH 18/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 975c53e6..e8b23348 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -60,7 +60,6 @@ Breaking Changes adding an organization search bar. This flag does not work in the Studio Home MFE, as it is not needed within the MFE. The MFE already have a search bar and pagination, which improves performance for those home pages with lots of courses. - adding an organization search bar. But as the report mentions, it's not working correctly in the Studio Home MFE. The good thing is that this flag is not needed in the Studio Home MFE since we already have a search bar and pagination, which improves performance for those home pages with lots of courses. I wouldn't consider From 4ef59a28d32066173b60ace279738de93088cafc Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:51:18 -0400 Subject: [PATCH 19/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index e8b23348..0b0227a4 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -60,7 +60,6 @@ Breaking Changes adding an organization search bar. This flag does not work in the Studio Home MFE, as it is not needed within the MFE. The MFE already have a search bar and pagination, which improves performance for those home pages with lots of courses. - correctly in the Studio Home MFE. The good thing is that this flag is not needed in the Studio Home MFE since we already have a search bar and pagination, which improves performance for those home pages with lots of courses. I wouldn't consider it a "breaking change" but a known issue for those who want to turn on the Studio From 68fdcdf17395bad9deb25d790c995947cd55445d Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:51:32 -0400 Subject: [PATCH 20/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 0b0227a4..efb64d1e 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -60,7 +60,6 @@ Breaking Changes adding an organization search bar. This flag does not work in the Studio Home MFE, as it is not needed within the MFE. The MFE already have a search bar and pagination, which improves performance for those home pages with lots of courses. - in the Studio Home MFE since we already have a search bar and pagination, which improves performance for those home pages with lots of courses. I wouldn't consider it a "breaking change" but a known issue for those who want to turn on the Studio Home MFE and are using the flag. From eb286c635f04dc04baa6ba285cbb3ddf89e97d50 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:51:47 -0400 Subject: [PATCH 21/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index efb64d1e..e1eb332f 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -60,7 +60,6 @@ Breaking Changes adding an organization search bar. This flag does not work in the Studio Home MFE, as it is not needed within the MFE. The MFE already have a search bar and pagination, which improves performance for those home pages with lots of courses. - improves performance for those home pages with lots of courses. I wouldn't consider it a "breaking change" but a known issue for those who want to turn on the Studio Home MFE and are using the flag. From 01f2e0c8440eba91c4ad283aa58b95f51b131adf Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:52:02 -0400 Subject: [PATCH 22/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index e1eb332f..09c72bdf 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -60,7 +60,6 @@ Breaking Changes adding an organization search bar. This flag does not work in the Studio Home MFE, as it is not needed within the MFE. The MFE already have a search bar and pagination, which improves performance for those home pages with lots of courses. - it a "breaking change" but a known issue for those who want to turn on the Studio Home MFE and are using the flag. Learner & Instructor Experiences From c20f29ea22a5e5b85576d3e081ded86b0f7eec2c Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:52:13 -0400 Subject: [PATCH 23/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 09c72bdf..cd5199b3 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -60,7 +60,6 @@ Breaking Changes adding an organization search bar. This flag does not work in the Studio Home MFE, as it is not needed within the MFE. The MFE already have a search bar and pagination, which improves performance for those home pages with lots of courses. - Home MFE and are using the flag. Learner & Instructor Experiences ******************************** From 86743801cf33fb9f2bd8611e915f87a7f7520939 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:52:36 -0400 Subject: [PATCH 24/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index cd5199b3..a0939be6 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -65,7 +65,6 @@ Learner & Instructor Experiences ******************************** See the Product Release Notes. -****************************** Instructor Experiences From c2e8477b102484faee1f0694a2971e3628bcbc4c Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:52:53 -0400 Subject: [PATCH 25/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index a0939be6..bef17a93 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -64,7 +64,26 @@ Breaking Changes Learner & Instructor Experiences ******************************** -See the Product Release Notes. +For in-depth information on new learner and instructor facing features in the Redwood release, please see the Feature-Based Release Notes. Instructions on how to enable those features are as follows. + +Courseware Sidebar +================== + +To enable the new Courseware Sidebar, set the ``courseware.enable_navigation_sidebar`` waffle flag to True. + +Connect Teams in a course to Content Groups +=========================================== + +#. Go to your site's Django Admin Panel + +#. Enable the teams feature by turning on the waffle flag: ``teams.enable_teams_app`` + +#. Then, turn on the ``teams.content_groups_for_teams`` waffle flag for everyone or specific courses with a waffle flag course overrides + +Make Sections available independently of the course outline +=========================================================== + +Enable this feature flag: ``FEATURES["ENABLE_HIDE_FROM_TOC_UI"] = True`` to your deployment configurations to enable the feature system-wide. Instructor Experiences From eb25be21942a54530d7308d9184579973cadb1b8 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 14:53:47 -0400 Subject: [PATCH 26/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index bef17a93..a6b6f924 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -86,7 +86,6 @@ Make Sections available independently of the course outline Enable this feature flag: ``FEATURES["ENABLE_HIDE_FROM_TOC_UI"] = True`` to your deployment configurations to enable the feature system-wide. -Instructor Experiences ********************** From 1b8096788016675e1ea87a0d0ec7832815f4f25b Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:21:26 -0400 Subject: [PATCH 27/56] docs: Add paver reminder in developer exp. Also remove orphaned underline. All as per review comments. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index a6b6f924..56af6318 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -85,10 +85,6 @@ Make Sections available independently of the course outline Enable this feature flag: ``FEATURES["ENABLE_HIDE_FROM_TOC_UI"] = True`` to your deployment configurations to enable the feature system-wide. - -********************** - - Administrators & Operators ************************** @@ -251,6 +247,9 @@ Deprecations & Removals Developer Experience ******************** +- *Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac* + - *Non deployment paver commands will be removed by Sumac* + Researcher & Data Experiences ***************************** From c24d107a848c3d6eb722224b0be693243af1ad03 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 21:39:04 -0400 Subject: [PATCH 28/56] docs: Add ALL missing removed toggles. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 37 ++++++++++++++-------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 56af6318..0af506d8 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -217,19 +217,29 @@ Deprecations & Removals - *Badges app has been deprecated and removed from ``edx-platform``. See `[DEPR]: lms/djangoapps/badges `_ .* - - - *``accomplishments_shared`` field is removed from payloads and - settings* - - - *``ENABLE_OPENBADGES`` is no longer available for configuration in - ``FEATURES``* - - - *``BADGING_BACKEND``, ``BADGR_BASE_URL``, ``BADGR_ISSUER_SLUG``, - ``BADGR_USERNAME``, ``BADGR_PASSWORD``, - ``BADGR_TOKENS_CACHE_KEY``, ``BADGR_TIMEOUT``, - ``BADGR_ENABLE_NOTIFICATIONS`` are also not configurable anymore.* - -- * In edxapp, the Waffle switch ``ip.legacy`` is removed. See `[DEPR]: legacy_ip code and Waffle switch `_ .* + - * ``accomplishments_shared`` field is removed from payloads and settings* + - * ``ENABLE_OPENBADGES, ENABLE_SEND_XBLOCK_EVENTS_OVER_BUS`` are no longer available for configuration in ``FEATURES``* + - * ``BADGING_BACKEND``, ``BADGR_BASE_URL``, ``BADGR_ISSUER_SLUG``,* + - * ``BADGR_USERNAME``, ``BADGR_PASSWORD``,* + - * ``BADGR_TOKENS_CACHE_KEY``, ``BADGR_TIMEOUT``,* + - * ``BADGR_ENABLE_NOTIFICATIONS``, ``SEND_CERTIFICATE_REVOKED_SIGNAL``,* + - * ``blockstore.use_blockstore_app_api``,* + - * ``contentstore.enable_copy_paste_units``,* + - * ``course_apps.proctoring_settings_modal_view``,* + - * ``course_live.enable_big_blue_button``,* + - * ``course_live.enable_course_live``,* + - * ``courseware.learning_assistant``,* + - * ``discussions.enable_learners_stats``,* + - * ``discussions.enable_learners_tab_in_discussions_mfe``,* + - * ``discussions.enable_moderation_reason_codes``,* + - * ``discussions.enable_reported_content_email_notifications``,* + - * ``learner_recommendations.enable_course_about_page_recommendations``,* + - * ``learner_recommendations.enable_dashboard_recommendations``,* + - * ``student.enable_2u_recommendations``,* + - * ``student.enable_amplitude_recommendations``,* + - * ``student.enable_fallback_recommendations``,* + - * ``blockstore.use_blockstore_app_api`` are also not configurable anymore.* +- - In edxapp, the Waffle switch ``ip.legacy`` is removed. See `[DEPR]: legacy_ip code and Waffle switch `_ .* - *Any deployment that has been relying on this legacy IP address option will need to switch to setting @@ -244,6 +254,7 @@ Deprecations & Removals relevant code has been archived.* - https://github.com/openedx/public-engineering/issues/224 + Developer Experience ******************** From 0e8f911f586deeccd776379767f1a724a76bea15 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 22:01:05 -0400 Subject: [PATCH 29/56] docs: Fix broken markup. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 49 ++++++++++------------ 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 0af506d8..dfcb988a 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -217,43 +217,40 @@ Deprecations & Removals - *Badges app has been deprecated and removed from ``edx-platform``. See `[DEPR]: lms/djangoapps/badges `_ .* - - * ``accomplishments_shared`` field is removed from payloads and settings* - - * ``ENABLE_OPENBADGES, ENABLE_SEND_XBLOCK_EVENTS_OVER_BUS`` are no longer available for configuration in ``FEATURES``* - - * ``BADGING_BACKEND``, ``BADGR_BASE_URL``, ``BADGR_ISSUER_SLUG``,* - - * ``BADGR_USERNAME``, ``BADGR_PASSWORD``,* - - * ``BADGR_TOKENS_CACHE_KEY``, ``BADGR_TIMEOUT``,* - - * ``BADGR_ENABLE_NOTIFICATIONS``, ``SEND_CERTIFICATE_REVOKED_SIGNAL``,* - - * ``blockstore.use_blockstore_app_api``,* - - * ``contentstore.enable_copy_paste_units``,* - - * ``course_apps.proctoring_settings_modal_view``,* - - * ``course_live.enable_big_blue_button``,* - - * ``course_live.enable_course_live``,* - - * ``courseware.learning_assistant``,* - - * ``discussions.enable_learners_stats``,* - - * ``discussions.enable_learners_tab_in_discussions_mfe``,* - - * ``discussions.enable_moderation_reason_codes``,* - - * ``discussions.enable_reported_content_email_notifications``,* - - * ``learner_recommendations.enable_course_about_page_recommendations``,* - - * ``learner_recommendations.enable_dashboard_recommendations``,* - - * ``student.enable_2u_recommendations``,* - - * ``student.enable_amplitude_recommendations``,* - - * ``student.enable_fallback_recommendations``,* - - * ``blockstore.use_blockstore_app_api`` are also not configurable anymore.* - - In edxapp, the Waffle switch ``ip.legacy`` is removed. See `[DEPR]: legacy_ip code and Waffle switch `_ .* - *Any deployment that has been relying on this legacy IP address option will need to switch to setting ``CLOSEST_CLIENT_IP_FROM_HEADERS`` appropriately. See `Nutmeg Announcement `_ for details.* - - *Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac* - `[DEPR]: Asset processing in Paver `_. - *Non deployment paver commands will be removed by Sumac* - -- *The django-splash capability was removed from edx-platform and the - relevant code has been archived.* +- *The django-splash capability was removed from edx-platform and the relevant code has been archived.* - https://github.com/openedx/public-engineering/issues/224 +* ``accomplishments_shared`` field is removed from payloads and settings* +* ``ENABLE_OPENBADGES``, ``ENABLE_SEND_XBLOCK_EVENTS_OVER_BUS`` are no longer available for configuration in ``FEATURES`` * +* ``BADGING_BACKEND``, ``BADGR_BASE_URL``, ``BADGR_ISSUER_SLUG``,* +* ``BADGR_USERNAME``, ``BADGR_PASSWORD``,* +* ``BADGR_TOKENS_CACHE_KEY``, ``BADGR_TIMEOUT``,* +* ``BADGR_ENABLE_NOTIFICATIONS``, ``SEND_CERTIFICATE_REVOKED_SIGNAL``,* +* ``blockstore.use_blockstore_app_api``,* +* ``contentstore.enable_copy_paste_units``,* +* ``course_apps.proctoring_settings_modal_view``,* +* ``course_live.enable_big_blue_button``,* +* ``course_live.enable_course_live``,* +* ``courseware.learning_assistant``,* +* ``discussions.enable_learners_stats``,* +* ``discussions.enable_learners_tab_in_discussions_mfe``,* +* ``discussions.enable_moderation_reason_codes``,* +* ``discussions.enable_reported_content_email_notifications``,* +* ``learner_recommendations.enable_course_about_page_recommendations``,* +* ``learner_recommendations.enable_dashboard_recommendations``,* +* ``student.enable_2u_recommendations``,* +* ``student.enable_amplitude_recommendations``,* +* ``student.enable_fallback_recommendations``,* +* ``blockstore.use_blockstore_app_api`` are also not configurable anymore.* Developer Experience ******************** From 6f071cac2cff0f2078b0f873db5c2d5a40f5a983 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 22:09:57 -0400 Subject: [PATCH 30/56] docs: Remove broken trailing asterisk. Fixes: https://github.com/openedx/wg-build-test-release/issues/377 --- source/community/release_notes/redwood.rst | 44 +++++++++++----------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index dfcb988a..bb428f81 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -229,28 +229,28 @@ Deprecations & Removals - *The django-splash capability was removed from edx-platform and the relevant code has been archived.* - https://github.com/openedx/public-engineering/issues/224 -* ``accomplishments_shared`` field is removed from payloads and settings* -* ``ENABLE_OPENBADGES``, ``ENABLE_SEND_XBLOCK_EVENTS_OVER_BUS`` are no longer available for configuration in ``FEATURES`` * -* ``BADGING_BACKEND``, ``BADGR_BASE_URL``, ``BADGR_ISSUER_SLUG``,* -* ``BADGR_USERNAME``, ``BADGR_PASSWORD``,* -* ``BADGR_TOKENS_CACHE_KEY``, ``BADGR_TIMEOUT``,* -* ``BADGR_ENABLE_NOTIFICATIONS``, ``SEND_CERTIFICATE_REVOKED_SIGNAL``,* -* ``blockstore.use_blockstore_app_api``,* -* ``contentstore.enable_copy_paste_units``,* -* ``course_apps.proctoring_settings_modal_view``,* -* ``course_live.enable_big_blue_button``,* -* ``course_live.enable_course_live``,* -* ``courseware.learning_assistant``,* -* ``discussions.enable_learners_stats``,* -* ``discussions.enable_learners_tab_in_discussions_mfe``,* -* ``discussions.enable_moderation_reason_codes``,* -* ``discussions.enable_reported_content_email_notifications``,* -* ``learner_recommendations.enable_course_about_page_recommendations``,* -* ``learner_recommendations.enable_dashboard_recommendations``,* -* ``student.enable_2u_recommendations``,* -* ``student.enable_amplitude_recommendations``,* -* ``student.enable_fallback_recommendations``,* -* ``blockstore.use_blockstore_app_api`` are also not configurable anymore.* +* ``accomplishments_shared`` field is removed from payloads and settings +* ``ENABLE_OPENBADGES``, ``ENABLE_SEND_XBLOCK_EVENTS_OVER_BUS`` are no longer available for configuration in ``FEATURES`` +* ``BADGING_BACKEND``, ``BADGR_BASE_URL``, ``BADGR_ISSUER_SLUG``, +* ``BADGR_USERNAME``, ``BADGR_PASSWORD``, +* ``BADGR_TOKENS_CACHE_KEY``, ``BADGR_TIMEOUT``, +* ``BADGR_ENABLE_NOTIFICATIONS``, ``SEND_CERTIFICATE_REVOKED_SIGNAL``, +* ``blockstore.use_blockstore_app_api``, +* ``contentstore.enable_copy_paste_units``, +* ``course_apps.proctoring_settings_modal_view``, +* ``course_live.enable_big_blue_button``, +* ``course_live.enable_course_live``, +* ``courseware.learning_assistant``, +* ``discussions.enable_learners_stats``, +* ``discussions.enable_learners_tab_in_discussions_mfe``, +* ``discussions.enable_moderation_reason_codes``, +* ``discussions.enable_reported_content_email_notifications``, +* ``learner_recommendations.enable_course_about_page_recommendations``, +* ``learner_recommendations.enable_dashboard_recommendations``, +* ``student.enable_2u_recommendations``, +* ``student.enable_amplitude_recommendations``, +* ``student.enable_fallback_recommendations``, +* ``blockstore.use_blockstore_app_api`` are also not configurable anymore. Developer Experience ******************** From 168fb71350ed565542695b6db09fcffc7deafedf Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 18:26:10 -0400 Subject: [PATCH 31/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index bb428f81..fa94da24 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -261,7 +261,15 @@ Developer Experience Researcher & Data Experiences ***************************** - +`Aspects `_ +is an analytics system for the Open edX platform, bringing actionable data +about course and learner performance to instructors and site operators. It is primarily +a Tutor plugin that ties together data from the Open edX learning management system +and Studio using open source tools to aggregate and transform learning traces into data +visualizations. + +See the `Aspects configuration documentation `_ +to learn about setting up Aspects for your production environment. Known Issues ************ From c5f527547d8d06310a3b127b426209b451f7f5d5 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:31:13 -0400 Subject: [PATCH 32/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index fa94da24..4793a0cb 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -146,7 +146,7 @@ Other Operator Changes - The default minimum password length has been updated from 2 characters to 8 characters. `(PR) `_. - - If you have an existing password, this change alone will not + - For users with an existing password, this change alone will not force you to update it. However if you reset your password or go to change it, you'll have to conform to the new guidelines. If you would like to force people to update their password, you'll From e0aae3448fb6cfa064ad45338e66018813f2e334 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:31:26 -0400 Subject: [PATCH 33/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 4793a0cb..5d85017b 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -221,7 +221,7 @@ Deprecations & Removals - *Any deployment that has been relying on this legacy IP address option will need to switch to setting - ``CLOSEST_CLIENT_IP_FROM_HEADERS`` appropriately. See `Nutmeg Announcement `_ for + ``CLOSEST_CLIENT_IP_FROM_HEADERS`` appropriately. See `Nutmeg Announcement `_ for details.* - *Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac* - `[DEPR]: Asset processing in Paver `_. From 2898bcdc3ad16a3c8e2854a7d5f3f3414055c663 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:31:57 -0400 Subject: [PATCH 34/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 5d85017b..9650c3ff 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -147,7 +147,7 @@ Other Operator Changes characters to 8 characters. `(PR) `_. - For users with an existing password, this change alone will not - force you to update it. However if you reset your password or go + force them to update it. However if they reset their password or go to change it, you'll have to conform to the new guidelines. If you would like to force people to update their password, you'll probably want to take a look at `the password_policy plugin and its settings `_ From 255762439fec8876645d3f2969bd8dc6355cebb2 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:32:23 -0400 Subject: [PATCH 35/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 9650c3ff..2fdc1564 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -223,7 +223,7 @@ Deprecations & Removals option will need to switch to setting ``CLOSEST_CLIENT_IP_FROM_HEADERS`` appropriately. See `Nutmeg Announcement `_ for details.* -- *Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac* +- Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac - `[DEPR]: Asset processing in Paver `_. - *Non deployment paver commands will be removed by Sumac* - *The django-splash capability was removed from edx-platform and the relevant code has been archived.* From 97b51f10ba4a76f25ac0d134d54bb36618d9dd3c Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:32:49 -0400 Subject: [PATCH 36/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 2fdc1564..38cee5bf 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -148,7 +148,7 @@ Other Operator Changes - For users with an existing password, this change alone will not force them to update it. However if they reset their password or go - to change it, you'll have to conform to the new guidelines. If you + to change it, they'll have to conform to the new guidelines. If you would like to force people to update their password, you'll probably want to take a look at `the password_policy plugin and its settings `_ From d8192baef0c5800a575c22cf1474f7174ab44178 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:33:14 -0400 Subject: [PATCH 37/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 38cee5bf..7ca09906 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -149,7 +149,7 @@ Other Operator Changes - For users with an existing password, this change alone will not force them to update it. However if they reset their password or go to change it, they'll have to conform to the new guidelines. If you - would like to force people to update their password, you'll + would like to force people to update their password, you probably want to take a look at `the password_policy plugin and its settings `_ - The following `requirements update `_ into credentials might have implications for anyone From a8a94d46cf0c45163bc8a8fc9d1d36682c2edc68 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:33:40 -0400 Subject: [PATCH 38/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 7ca09906..ab948f6a 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -150,7 +150,7 @@ Other Operator Changes force them to update it. However if they reset their password or go to change it, they'll have to conform to the new guidelines. If you would like to force people to update their password, you - probably want to take a look at `the password_policy plugin and its settings `_ + should take a look at `the password_policy plugin and its settings `_ - The following `requirements update `_ into credentials might have implications for anyone who has a massive ``usersocialauth`` table.  This is because that From ff43c4d2821fb4da9dc109cb6cc386f8bd776a8b Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:34:00 -0400 Subject: [PATCH 39/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index ab948f6a..db52a499 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -152,7 +152,7 @@ Other Operator Changes would like to force people to update their password, you should take a look at `the password_policy plugin and its settings `_ -- The following `requirements update `_ into credentials might have implications for anyone +- The Credentials service `updated some requirements `_ and may have implications for anyone who has a massive ``usersocialauth`` table.  This is because that table grows endlessly, and the migrations on the table caused by updating the ``social-auth-app-django`` package can run out of From f6fc9ea99fd82fb03daefdd7b2662a90acd3b64d Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:34:18 -0400 Subject: [PATCH 40/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index db52a499..983d1a06 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -157,7 +157,7 @@ Other Operator Changes table grows endlessly, and the migrations on the table caused by updating the ``social-auth-app-django`` package can run out of memory. If maintainers have migration failures on this upgrade, they - should run the management command `truncate_social_auth `_.* + should run the management command `truncate_social_auth `_. - This will remove all entries from the ``usersocialauth`` table that haven't been updated in 90 days, which makes the size of the From 9ee006e2accf5140cf82e3bbf2b6d0e9ddd1043e Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:34:30 -0400 Subject: [PATCH 41/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 983d1a06..60a3181e 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -162,7 +162,7 @@ Other Operator Changes - This will remove all entries from the ``usersocialauth`` table that haven't been updated in 90 days, which makes the size of the table tractable for the dependency's migration. This is harmless - in the ``Credentials`` IDA.* + in the ``Credentials`` IDA. - The scripts related to user retirement across all services have been moved to the ``edx-platform`` repository. If you’ve been From 80c2a8cc580a4ed6e1e4f0a2b892cbd4bd023cb6 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:34:58 -0400 Subject: [PATCH 42/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 60a3181e..8c9fff2a 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -166,7 +166,7 @@ Other Operator Changes - The scripts related to user retirement across all services have been moved to the ``edx-platform`` repository. If you’ve been - using the tubular repo to run retirement scripts you should update + using the `unsupported tubular repository `_ to run retirement scripts you should update your code.* - *Relevant Tickets* From 5e61ce43e7f480893106602b04f135aa4d76ce71 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:35:14 -0400 Subject: [PATCH 43/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 8c9fff2a..8bed0aec 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -167,7 +167,7 @@ Other Operator Changes - The scripts related to user retirement across all services have been moved to the ``edx-platform`` repository. If you’ve been using the `unsupported tubular repository `_ to run retirement scripts you should update - your code.* + your code. - *Relevant Tickets* - `Move user retirement code to edx-platform and drop it from Tubular `_. From fcf92869551342cf5f9108d58d04f275a0fe4b66 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:35:25 -0400 Subject: [PATCH 44/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 8bed0aec..ae10a4d0 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -174,7 +174,10 @@ Other Operator Changes - `Move user retirement scripts code from the tubular repo `_. - `Deprecate User Retirement Scripts `_. -- *edx-platform and cs_comment_service Mongo Upgrades* +- edx-platform and cs_comment_service Mongo Upgrades + - Operators will need to `update their Mongo databases to Mongo 7 `_ to ensure their deployments don't break in the future. + - Operators will need to update their forums' Ruby version from 3.0 to 3.3. + - If you're running Tutor and your Mongo/Ruby are in Tutor, they will get automatically upgraded. - `chore: add mongo 7 to testing matrix `_. - `build: Build with newer ruby and mongo versions. `_. From e63855732827f185156534c924e7d84a12023725 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:35:36 -0400 Subject: [PATCH 45/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index ae10a4d0..d894388d 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -185,7 +185,7 @@ Other Operator Changes as it depends on a new search engine, Meilisearch. We encourage operators to install Meilisearch, test out this feature, and give us feedback on the viability of using Meilisearch as a replacement for - Elasticsearch in future releases of Open edX. Here’s how:* + Elasticsearch in future releases of Open edX. Here’s how to enable it: - For tutor-based deployments, install the `tutor-contrib-mailsearch `_ plugin, and apply the changes to your deployment. See that plugin’s README for details. From 68cfb239a6f1224d03a0f95cb3e86728a9c7f20e Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:35:56 -0400 Subject: [PATCH 46/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index d894388d..c2713bfe 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -191,7 +191,7 @@ Other Operator Changes changes to your deployment. See that plugin’s README for details. Note in particular that the hostname configured as ``MEILISEARCH_PUBLIC_HOST`` must be resolvable on the public - internet.* + internet. - If you are not using Tutor, you’ll need to install Meilisearch manually (or use the cloud product), and to explicitly set `the related config variables `_ in the From 32903a71e064d7878aa59227d7a8d0344d40b982 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:37:11 -0400 Subject: [PATCH 47/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index c2713bfe..4625249a 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -194,7 +194,7 @@ Other Operator Changes internet. - If you are not using Tutor, you’ll need to install Meilisearch - manually (or use the cloud product), and to explicitly set `the related config variables `_ in the + manually (or use the cloud product) and explicitly set `the related config variables `_ in the CMS as well as set ``MEILISEARCH_ENABLED=true`` in the Course Authoring MFE settings.* From e2e7b8b4557143919a33c29c69338ad393f0faa5 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:37:22 -0400 Subject: [PATCH 48/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 4625249a..a3798895 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -196,7 +196,7 @@ Other Operator Changes - If you are not using Tutor, you’ll need to install Meilisearch manually (or use the cloud product) and explicitly set `the related config variables `_ in the CMS as well as set ``MEILISEARCH_ENABLED=true`` in the Course - Authoring MFE settings.* + Authoring MFE settings. - To create and populate the search index, you must run a one-time command from the CMS shell: From bb0bb3fd9699693647329d9a540b5eb4fabaa34c Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:37:35 -0400 Subject: [PATCH 49/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index a3798895..431b18bd 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -198,7 +198,7 @@ Other Operator Changes CMS as well as set ``MEILISEARCH_ENABLED=true`` in the Course Authoring MFE settings. - - To create and populate the search index, you must run a one-time + - Whether or not you're using Tutor, you'll need to create and populate the search index. To do so, you must run a one-time command from the CMS shell: ``python manage.py cms reindex_studio --experimental``. This command may take a while if you have a lot of courses and/or From 7a25c2ead0e5dc095b5ec741e3fb0cc87d804503 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:37:46 -0400 Subject: [PATCH 50/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 431b18bd..e30bcf8d 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -208,7 +208,7 @@ Other Operator Changes This command reads from MySQL/MongoDB but does not write to them; it only writes to Meilisearch. Once the indexing has completed, it should not be necessary to run it again; from that point forward, - the indexes will be updated automatically as needed.* + the indexes will be updated automatically as needed. - Please share your feedback about Meilisearch, indexing, and operations in `this Discourse thread `_ or the `#ops `_ Slack channel. Please share feedback about From 6f3ea9ab94a85ba77b5e2c4341cd6b2b5e85615e Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:37:58 -0400 Subject: [PATCH 51/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index e30bcf8d..0f25c2c7 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -212,7 +212,7 @@ Other Operator Changes - Please share your feedback about Meilisearch, indexing, and operations in `this Discourse thread `_ or the `#ops `_ Slack channel. Please share feedback about - the new course search feature in general `in the discussion forums `_ or in the `#wg-product-core `_ Slack channel.* + the new course search feature in general `in the discussion forums `_ or in the `#wg-product-core `_ Slack channel. Deprecations & Removals From 1909816599040f92db149d890a2042b5cfde0778 Mon Sep 17 00:00:00 2001 From: Chris Patti Date: Tue, 18 Jun 2024 19:38:12 -0400 Subject: [PATCH 52/56] Update source/community/release_notes/redwood.rst Co-authored-by: Sarina Canelake --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 0f25c2c7..705ef1f6 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -218,7 +218,7 @@ Other Operator Changes Deprecations & Removals *********************** -- *Badges app has been deprecated and removed from ``edx-platform``. +- Badges app has been deprecated and removed from ``edx-platform``. See `[DEPR]: lms/djangoapps/badges `_ .* - - In edxapp, the Waffle switch ``ip.legacy`` is removed. See `[DEPR]: legacy_ip code and Waffle switch `_ .* From 70d1247c37c921ade9952336b8ffd1ad31d13486 Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Wed, 19 Jun 2024 09:56:22 -0400 Subject: [PATCH 53/56] Update source/community/release_notes/redwood.rst --- source/community/release_notes/redwood.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 705ef1f6..166ef08c 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -150,7 +150,7 @@ Other Operator Changes force them to update it. However if they reset their password or go to change it, they'll have to conform to the new guidelines. If you would like to force people to update their password, you - should take a look at `the password_policy plugin and its settings `_ + should take a look at `the password_policy plugin and its settings `_ - The Credentials service `updated some requirements `_ and may have implications for anyone who has a massive ``usersocialauth`` table.  This is because that From 0cf27ad667a66653510ecb074c9ea5957e53c1ee Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Wed, 19 Jun 2024 10:21:25 -0400 Subject: [PATCH 54/56] Apply suggestions from code review --- source/community/release_notes/redwood.rst | 29 +++++++++++++++------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 166ef08c..074421ce 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -169,7 +169,8 @@ Other Operator Changes using the `unsupported tubular repository `_ to run retirement scripts you should update your code. - - *Relevant Tickets* + - Relevant Tickets + - `Move user retirement code to edx-platform and drop it from Tubular `_. - `Move user retirement scripts code from the tubular repo `_. - `Deprecate User Retirement Scripts `_. @@ -219,18 +220,23 @@ Deprecations & Removals *********************** - Badges app has been deprecated and removed from ``edx-platform``. - See `[DEPR]: lms/djangoapps/badges `_ .* -- - In edxapp, the Waffle switch ``ip.legacy`` is removed. See `[DEPR]: legacy_ip code and Waffle switch `_ .* + See `[DEPR]: lms/djangoapps/badges `_ . +- - In edxapp, the Waffle switch ``ip.legacy`` is removed. See `[DEPR]: legacy_ip code and Waffle switch `_ . - - *Any deployment that has been relying on this legacy IP address + - Any deployment that has been relying on this legacy IP address option will need to switch to setting ``CLOSEST_CLIENT_IP_FROM_HEADERS`` appropriately. See `Nutmeg Announcement `_ for - details.* + details. - Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac - - `[DEPR]: Asset processing in Paver `_. + + - `[DEPR]: Asset processing in Paver`_. - *Non deployment paver commands will be removed by Sumac* -- *The django-splash capability was removed from edx-platform and the relevant code has been archived.* + +- The ``django-splash`` capability was removed from ``edx-platform`` and the relevant code has been archived. + - https://github.com/openedx/public-engineering/issues/224 +Flags and toggles removed in Redwood +==================================== * ``accomplishments_shared`` field is removed from payloads and settings * ``ENABLE_OPENBADGES``, ``ENABLE_SEND_XBLOCK_EVENTS_OVER_BUS`` are no longer available for configuration in ``FEATURES`` @@ -258,8 +264,12 @@ Deprecations & Removals Developer Experience ******************** -- *Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac* - - *Non deployment paver commands will be removed by Sumac* +- Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac + + - - `[DEPR]: Asset processing in Paver`_. + - Non deployment paver commands will be removed by Sumac + +.. _ [DEPR]: Asset processing in Paver: https://github.com/openedx/edx-platform/issues/31895 Researcher & Data Experiences ***************************** @@ -273,6 +283,7 @@ visualizations. See the `Aspects configuration documentation `_ to learn about setting up Aspects for your production environment. + Known Issues ************ From bab4c0826f6fd39353583847e8259cfcc20db733 Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Wed, 19 Jun 2024 10:38:17 -0400 Subject: [PATCH 55/56] fixing build errors --- source/community/release_notes/redwood.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 074421ce..329fe281 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -235,6 +235,7 @@ Deprecations & Removals - The ``django-splash`` capability was removed from ``edx-platform`` and the relevant code has been archived. - https://github.com/openedx/public-engineering/issues/224 + Flags and toggles removed in Redwood ==================================== @@ -269,7 +270,7 @@ Developer Experience - - `[DEPR]: Asset processing in Paver`_. - Non deployment paver commands will be removed by Sumac -.. _ [DEPR]: Asset processing in Paver: https://github.com/openedx/edx-platform/issues/31895 +.. _[DEPR]: Asset processing in Paver: https://github.com/openedx/edx-platform/issues/31895 Researcher & Data Experiences ***************************** From 8a0622cc4cdf76a04183a5d2a2f8df40225e66d6 Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Wed, 19 Jun 2024 10:47:18 -0400 Subject: [PATCH 56/56] more build errors --- source/community/release_notes/redwood.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 329fe281..17bee4c5 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -229,7 +229,7 @@ Deprecations & Removals details. - Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac - - `[DEPR]: Asset processing in Paver`_. + - `[DEPR] Asset processing in Paver`_. - *Non deployment paver commands will be removed by Sumac* - The ``django-splash`` capability was removed from ``edx-platform`` and the relevant code has been archived. @@ -267,10 +267,10 @@ Developer Experience - Asset Processing (webpack, collectstatic, etc.) using Paver Commands in edx-platform is now Deprecated and will not be available in Sumac - - - `[DEPR]: Asset processing in Paver`_. + - - `[DEPR] Asset processing in Paver`_. - Non deployment paver commands will be removed by Sumac -.. _[DEPR]: Asset processing in Paver: https://github.com/openedx/edx-platform/issues/31895 +.. _[DEPR] Asset processing in Paver: https://github.com/openedx/edx-platform/issues/31895 Researcher & Data Experiences *****************************