docs: Redwood release notes first cut.

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 <redwood>
-    Quince: The current release <quince>
+    Redwood: The current release <redwood>
+    Sumac: The next release <sumac>
     named_release_branches_and_tags
     old_releases

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

source/community/release_notes/redwood.rst

@@ -13,9 +13,65 @@ 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.*``
 
-Learner Experiences
-*******************
+   -  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.
+
+   -  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.
+
+- `studio_home.enable_global_staff_optimization flag no longer works in Studio MFE <https://github.com/openedx/wg-build-test-release/issues/380>`_
+   - 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
+     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 & Instructor Experiences
+********************************
+
+See the Product Release Notes.
+******************************
 
 
 Instructor Experiences
@@ -25,10 +81,161 @@ Instructor Experiences
 Administrators & Operators
 **************************
 
+Settings and Toggles
+====================
+
+Waffle flags added In Redwood:
+
+* `ANONYMOUS_SURVEY_REPORT <https://github.com/openedx/edx-platform/blob/7d11c889bbbf55dfa69c734122de72d83c1893bf/lms/envs/common.py#L5523>`_
+* `ENFORCE_SESSION_EMAIL_MATCH <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/envs/common.py#L5110>`_
+* `FEATURES['ENABLE_BLAKE2B_HASHING'] <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/envs/common.py#L1068>`_
+* `FEATURES['ENABLE_CERTIFICATES_INSTRUCTOR_MANAGE] <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/instructor/settings/common.py#L95>`_
+* `FEATURES['ENABLE_COURSEWARE_SEARCH_VERIFIED_REQUIRED'] <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/envs/common.py#L1059>`_
+* `FEATURES['ENABLE_GRADING_METHOD_IN_PROBLEMS'] - LMS <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/envs/common.py#L1050>`_
+* `FEATURES['ENABLE_GRADING_METHOD_IN_PROBLEMS'] - CMS <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/cms/envs/common.py#L575>`_
+* `FEATURES['ENABLE_HIDE_FROM_TOC_UI'] <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/cms/envs/common.py#L555>`_
+* `FEATURES['ENABLE_HOME_PAGE_COURSE_API_V2'] <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/cms/envs/common.py#L565>`_
+* `FEATURES['ENABLE_LTI_PII_ACKNOWLEDGEMENT'] <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/cms/envs/common.py#L497>`_
+* `FEATURES['ENABLE_SEND_XBLOCK_LIFECYCLE_EVENTS_OVER_BUS'] <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/cms/envs/common.py#L542>`_
+* `FEATURES['SEND_LEARNING_CERTIFICATE_LIFECYCLE_EVENTS_TO_BUS'] <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/envs/common.py#L1038>`_
+* `JWT_AUTH_ADD_KID_HEADER: <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/oauth_dispatch/jwt.py#L279>`_
+* `SURVEY_REPORT_ENABLE <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/envs/common.py#L5571>`_
+* `agreements.enable_lti_pii_acknowledgement <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/agreements/toggles.py#L8>`_
+* `commerce.transition_to_coordinator.checkout <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/commerce/waffle.py#L9>`_
+* `commerce.transition_to_coordinator.refund <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/commerce/waffle.py#L23>`_
+* `content_tagging.disabled <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/content_tagging/toggles.py#L22>`_
+* `contentstore.new_studio_mfe.use_new_certificates_page <https://github.com/openedx/edx-platform/blob/f256684646aec6fd0d5519c6900ec99077e7db50/cms/djangoapps/contentstore/toggles.py#L484>`_
+* `contentstore.new_studio_mfe.use_new_group_configurations_page <https://github.com/openedx/edx-platform/blob/f256684646aec6fd0d5519c6900ec99077e7db50/cms/djangoapps/contentstore/toggles.py#L524>`_
+* `contentstore.new_studio_mfe.use_new_textbooks_page <https://github.com/openedx/edx-platform/blob/f256684646aec6fd0d5519c6900ec99077e7db50/cms/djangoapps/contentstore/toggles.py#L504>`_
+* `course_home.new_discussion_sidebar_view <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/course_home_api/toggles.py#L24>`_
+* `teams.content_groups_for_teams <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/lib/teams_config.py#L22>`_
+* `courseware.always_open_auxiliary_sidebar <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/courseware/toggles.py#L98>`_
+* `courseware.disable_navigation_sidebar_blocks_caching <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/courseware/toggles.py#L71>`_
+* `courseware.discovery_default_language_filter <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/courseware/toggles.py#L159>`_
+* `courseware.enable_navigation_sidebar <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/courseware/toggles.py#L86>`_
+* `discussions.enable_reported_content_notifications <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/discussion/toggles.py#L16>`_
+* `notifications.enable_coursewide_notifications <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/notifications/config/waffle.py#L41>`_
+* `notifications.enable_email_notifications <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/notifications/config/waffle.py#L61>`_
+* `notifications.enable_notifications_filters <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/notifications/config/waffle.py#L31>`_
+* `notifications.enable_ora_staff_notifications <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/notifications/config/waffle.py#L51>`_
+* `student.redirect_to_courseware_after_enrollment <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/common/djangoapps/student/toggles.py#L29>`_
+* `studio.enable_course_update_notifications <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/cms/djangoapps/contentstore/config/waffle.py#L58>`_
+* `user_tours.tours_disabled <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/lms/djangoapps/user_tours/toggles.py#L7>`_
+* `video_config.transcript_feedback <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/video_config/toggles.py#L19>`_
+* `video_config.xpert_translations_ui <https://github.com/openedx/edx-platform/blob/b3df1ddb670e9d4dfd68d1a696ea528aed859550/openedx/core/djangoapps/video_config/toggles.py#L30>`_
+* `ENABLE_AUTO_GENERATED_USERNAME <https://github.com/openedx/edx-platform/blob/7d11c889bbbf55dfa69c734122de72d83c1893bf/openedx/core/djangoapps/user_authn/toggles.py#L38>`_
+* `EDX_DRF_EXTENSIONS[ENABLE_JWT_AND_LMS_USER_EMAIL_MATCH] <https://github.com/openedx/edx-drf-extensions/blob/85880da4c50fcfd7d3d5190444b848ae9f174968/edx_rest_framework_extensions/config.py#L19>`_
+* `FEATURES['ENABLE_ORA_SELECTABLE_LEARNER_WAITING_REVIEW'] <https://github.com/openedx/edx-ora2/blob/8b320d69745a92aa64696c5f2617bd76dff88cb3/openassessment/xblock/config_mixin.py#L175>`_
+* `enterprise.enterprise_groups_v1 <https://github.com/openedx/edx-enterprise/blob/007abaf5b10707607d47a9f9d89572b36d18b8e2/enterprise/toggles.py#L34>`_
+* `enterprise.feature_prequery_search_suggestions <https://github.com/openedx/edx-enterprise/blob/007abaf5b10707607d47a9f9d89572b36d18b8e2/enterprise/toggles.py#L22>`_
+* `EVENT_BUS_PRODUCER_CONFIG['org.openedx.content_authoring.course.catalog_info.changed.v1'] <https://github.com/openedx/edx-platform/blob/7d11c889bbbf55dfa69c734122de72d83c1893bf/cms/envs/common.py#L2849>`_
+* `EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.course.unenrollment.completed.v1'] <https://github.com/openedx/edx-platform/blob/7d11c889bbbf55dfa69c734122de72d83c1893bf/lms/envs/common.py#L5428>`_
+* `EVENT_BUS_PRODUCER_CONFIG['org.openedx.learning.xblock.skill.verified.v1'] <https://github.com/openedx/edx-platform/blob/7d11c889bbbf55dfa69c734122de72d83c1893bf/lms/envs/common.py#L5443>`_
+
+
+Other Operator Changes
+======================
+
+-  The default minimum password length has been updated from 2
+   characters to 8 characters. `(PR) <https://github.com/openedx/edx-platform/pull/33373>`_.
+
+   -  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
+      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 <https://github.com/openedx/credentials/commit/1cd7c25c04a955aa9aaa263fb40ebd3f73d0937e>`_ 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 <https://github.com/openedx/credentials/blob/master/credentials/apps/core/management/commands/truncate_social_auth.py>`_.*
+
+   -  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 <https://github.com/openedx/axim-engineering/issues/881>`_.
+      - `Move user retirement scripts code from the tubular repo <https://github.com/openedx/edx-platform/pull/34063>`_.
+      - `Deprecate User Retirement Scripts <https://github.com/openedx-unsupported/tubular/pull/736>`_.
+
+-  *edx-platform and cs_comment_service Mongo Upgrades*
+      - `chore: add mongo 7 to testing matrix <https://github.com/openedx/edx-platform/pull/34213>`_.
+      - `build: Build with newer ruby and mongo versions. <https://github.com/openedx/cs_comments_service/pull/426>`_.
+
+-  The Redwood release includes the `Studio Course Search [BETA] <https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4247257093/BETA+Course+Search+-+Product+Release+Notes>`_, 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 <https://github.com/open-craft/tutor-contrib-meilisearch>`_ 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 <https://github.com/openedx/edx-platform/blob/aac70563fd8a1492af25ae1b9aa9d14c42b36a18/cms/envs/common.py#L2958-L2969>`_ 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 <https://discuss.openedx.org/t/is-meilisearch-a-viable-upgrade-alternative-to-opensearch/12400>`_ or the `#ops <https://openedx.slack.com/archives/C08B4LZEZ>`_ Slack channel. Please share feedback about
+      the new course search feature in general `in the discussion forums <https://discuss.openedx.org/t/feedback-thread-new-course-search/13076>`_ or in the `#wg-product-core <https://openedx.slack.com/archives/C057J2D1WU9>`_ Slack channel.*
+
 
 Deprecations & Removals
 ***********************
 
+-  *Badges app has been deprecated and removed from ``edx-platform``.
+   See `[DEPR]: lms/djangoapps/badges <https://github.com/openedx/edx-platform/issues/31541>`_ .*
+
+   -  *``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 <https://github.com/openedx/edx-platform/issues/33733>`_ .*
+
+   -  *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 <https://openedx.atlassian.net/wiki/spaces/COMM/pages/3205201949>`_ 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 <https://github.com/openedx/edx-platform/issues/31895>`_.
+   -  *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
 ********************
@@ -39,3 +246,5 @@ Researcher & Data Experiences
 
 Known Issues
 ************
+
+Please refer to `this board <https://github.com/orgs/openedx/projects/28/views/16>`_ for known issues with Redwood.

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 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
+
+.. 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
+************

source/index.rst

@@ -43,7 +43,7 @@ Open edX Documentation
          :maxdepth: 1
          :caption: Open Source Community
 
-         Current Release: Quince <community/release_notes/quince>
+         Current Release: Redwood <community/release_notes/redwood>
          All Release Notes <community/release_notes/index>
          How to Contribute <https://openedx.atlassian.net/wiki/spaces/COMM/pages/941457737/How+to+start+contributing+to+the+Open+edX+code+base>
          OEPs (Open edX Proposals): Community Decision Documents <https://docs.openedx.org/projects/openedx-proposals/en/latest/>