Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sumac Release Notes #622

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
+95 −6
Open

Sumac Release Notes #622

Changes from 5 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
f551b19
feat: Preliminary cut of Sumac release notes. Incomplete.
feoh Oct 31, 2024
e305eeb
docs: initial cut of release notes for OpenEdX Sumac
feoh Nov 22, 2024
0cbdc8f
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 3, 2024
c8d76fa
docs: Add note about newly enabled by default sidebar toggle.
feoh Dec 3, 2024
a6ba69c
docs: Added new settings for Sumac. (Still need to add feature toggles).
feoh Dec 6, 2024
8862dc9
docs: Add most feature toggles
feoh Dec 9, 2024
d647d80
docs: Add missing feature flags from other repos.
feoh Dec 10, 2024
484412b
docs: Add zooming image tool DEPR
feoh Dec 10, 2024
fb062a1
docs: Add blank line to trigger Sphinx rebuild
feoh Dec 10, 2024
a094d09
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
01efc6b
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
c64064e
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
4bbeb8f
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
74b9f4b
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
61c1cc6
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
44263ca
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
0dc6106
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
d917c51
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 10, 2024
52ce181
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 11, 2024
ae099ce
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 11, 2024
2f7c1f9
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 11, 2024
c052956
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 11, 2024
7effbb6
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 11, 2024
f7c0429
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 11, 2024
fc9f81c
docs: Add link to Sumac upgrade feature PR.
feoh Dec 11, 2024
cca982a
docs: Make Sabrina suggested category consolidation
feoh Dec 11, 2024
970b2c8
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 11, 2024
aa5abb4
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 11, 2024
96968dc
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 12, 2024
a1056a1
docs: Add removed toggles as per review feedback.
feoh Dec 12, 2024
111cd50
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 12, 2024
3dec30b
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 12, 2024
2d130d9
Update source/community/release_notes/sumac/dev_op_release_notes.rst
feoh Dec 12, 2024
450c28a
docs: Add DEPR meeting results from Peter and fix RST bogons.
feoh Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion source/community/release_notes/sumac/dev_op_release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,25 @@ Instructor Experiences
Administrators & Operators
**************************

feoh marked this conversation as resolved.
Show resolved Hide resolved
- `Course assets should be served by a view rather than a middleware <https://github.com/openedx/edx-platform/issues/34702>`_
feoh marked this conversation as resolved.
Show resolved Hide resolved
- Background: The LMS/CMS previously handled course asset requests (asset-v1: andc4x URLs) via a middleware called StaticContentServer. This middleware has been converted to a view.
- Action: If your deployment has a custom MIDDLEWARE list in Django, you will need to remove this item at the time of upgrade to Sumac. Otherwise, no action is needed..
feoh marked this conversation as resolved.
Show resolved Hide resolved
- Ubuntu 22.04 Related Operators Note
- `PR <https://github.com/openedx/edx-platform/pull/35450>`_
- In newer versions of ubuntu the MD4 hashing algorithm is disabled by default. To enable it the openssl config needs to be updated in a manner similar to what's being done here. Alternatively, you can set the FEATURES['ENABLE_BLAKE2B_HASHING'] setting to True which will switch to a newer hashing algorithm where MD4 was previously used.
Because this hashing is being used as a part of the edx-platform caching mechanism, this will effectively clear the cache for the items that use this hash. The will impact any items where the cache key might have been too big to store in memcache so it's hard to predict exactly which items will be impacted.
- Added override options to commerce related CTA URLs in edx-platform
feoh marked this conversation as resolved.
Show resolved Hide resolved
- Background: Extension points have been added have been added to commerce app in: `PR1 <https://github.com/openedx/edx-platform/pull/35441>`_, `PR2 <https://github.com/openedx/edx-platform/pull/35501>` so openedX community members who wants to extend the commerce functionality can do so without explicitly adding code into edx-platform codebase. For more information into extension points see Pluggable override section in `Extension Points <https://github.com/openedx/edx-platform/blob/master/docs/concepts/extension_points.rst>`_.
feoh marked this conversation as resolved.
Show resolved Hide resolved
- Additional Considerations: Commerce app itself is slated for deprecation nevertheless.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to DEPR ticket would be good

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sarina Thanks! Whose cage should I politely rattle to figure out which DEPR to link here please? :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@feanil

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original DEPR was here: openedx/public-engineering#22

There is not one yet for the commerce app which we'll likely leave in for a bit longer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@feanil @sarina I'm super confused about how to handle this.

The current block says:

- Added override options to commerce related CTA URLs in edx-platform
   - Background: Extension points have been added have been added to commerce app in: `PR1 <https://github.com/openedx/edx-platform/pull/35441>`_, `PR2 <https://github.com/openedx/edx-platform/pull/35501>`_ so Open edX community members who wants to extend the commerce functionality can do so without explicitly adding code into edx-platform codebase. For more information into extension points see Pluggable override section in `Extension Points <https://github.com/openedx/edx-platform/blob/master/docs/concepts/extension_points.rst>`_.
   - Additional Considerations: Commerce app itself is slated for deprecation nevertheless.

Where do I link that DEPR in? And do I just delete the "Additional Considerations" bullet?

Signed,
-Living In A State of Confusion

- `courseware.enable_navigation_sidebar <https://github.com/openedx/edx-platform/blob/38f73442e78a8b9afb5543facd170dca830acb1a/lms/djangoapps/courseware/toggles.py#L86>`_ is now enabled by default. It was disabled by default in Redwood.
feoh marked this conversation as resolved.
Show resolved Hide resolved

feoh marked this conversation as resolved.
Show resolved Hide resolved
Settings and Toggles
feoh marked this conversation as resolved.
Show resolved Hide resolved
====================
- `contentstore.new_studio_mfe.disable_legacy_libraries <https://github.com/openedx/edx-platform/blob/2c575209f1177f095860a89b0c0ac080db9442a1/cms/djangoapps/contentstore/toggles.py#L613>`_
- `contentstore.new_studio_mfe.disable_new_libraries <https://github.com/openedx/edx-platform/blob/2c575209f1177f095860a89b0c0ac080db9442a1/cms/djangoapps/contentstore/toggles.py#L641C1-L641C2>`_
- `DISABLED_COUNTRIES <https://github.com/openedx/edx-platform/blob/b07464ba2dc4e397af799e40effd2e267516ea2a/cms/envs/common.py#L2956>`_
- `GRADEBOOK_FREEZE_DAYS <https://github.com/openedx/edx-platform/blob/b07464ba2dc4e397af799e40effd2e267516ea2a/lms/envs/common.py#L1098>`_
- `XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE <https://github.com/openedx/edx-platform/blob/b07464ba2dc4e397af799e40effd2e267516ea2a/cms/envs/common.py#L1034>`_


Other Operator Changes
Expand All @@ -40,7 +57,15 @@ Other Operator Changes
Deprecations & Removals
***********************

feoh marked this conversation as resolved.
Show resolved Hide resolved

- In `frontend-app-learner-dashboard <https://github.com/openedx/frontend-app-learner-dashboard>`_
- support for Optimizely has been removed along with the ProductRecommendations widget.
- `DEPR: Optimizely Support <https://github.com/openedx/frontend-app-learner-dashboard/issues/387>`_
- Removed the RecommendationsPanel widget
- `DEPR: RecommendationsPanel <https://github.com/openedx/frontend-app-learner-dashboard/issues/410>`_
- In edx-platform:
- ``commerce-coordinator`` related code has been removed
- `PR: <https://github.com/openedx/edx-platform/pull/35527>`_
feoh marked this conversation as resolved.
Show resolved Hide resolved
- [UPCOMING] In Teak pre-design-tokens brand packages will no longer be supported. With design tokens, theme authors will instead override core Paragon tokens by defining their own JSON tokens that get deep merged alongside the core Paragon tokens, thus overriding any tokens that were defined by the theme author. See `the associated DEPR ticket for details <https://github.com/openedx/brand-openedx/issues/23>`_.
feoh marked this conversation as resolved.
Show resolved Hide resolved
feoh marked this conversation as resolved.
Show resolved Hide resolved
Developer Experience
********************
feoh marked this conversation as resolved.
Show resolved Hide resolved

Expand Down