Sumac Release Notes

[feoh]

I'm quite sure lots of folks haven't included things they want in the notes as of yet but this is what I have for now.

Rendered page: https://docsopenedxorg--622.org.readthedocs.build/en/622/community/release_notes/sumac/dev_op_release_notes.html

[openedx-webhooks]

Thanks for the pull request, @feoh!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/docs-openedx-org-maintainers. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[crathbun428]

Here is a list of new or updated feature flags added this release that we know of on the product side:

1. For libraries, here is a link to the configuration details for what we're adding to libraries this release: link
2. For the left-sidebar navigation, we aren't adding any new toggles or switches this release, but we are updating the default configuration of this waffle flag: courseware.enable_navigation_sidebar from False (in Redwood) to True in Sumac to enable the new Courseware Sidebar

[feoh]

Here is a list of new or updated feature flags added this release that we know of on the product side:

1. For libraries, here is a link to the configuration details for what we're adding to libraries this release: [link](https://github.com/openedx/frontend-app-authoring/issues/1334)

2. For the left-sidebar navigation, we aren't adding any new toggles or switches this release, but we are updating the default configuration of this waffle flag: courseware.enable_navigation_sidebar from False (in Redwood) to True in Sumac to enable the new Courseware Sidebar

Thank you! I added a line about the newly default enabled sidebar nav toggle. As to the library configuration stuff, not sure how much of that needs to be in the dev/ops section of the release notes. I'm assuming it will be covered elsewhere. Please let me know if I'm wrong about that, and give me some text you'd like to see added as I have no idea what to write for this otherwise.

[sarina]

@ormsbee are there docs on library configuration that would be appropriate to link to from the developer release notes?

[pdpinch]

Please mention the deprecation of the "Zooming image tool" openedx/edx-platform#31436

[feoh]

Please mention the deprecation of the "Zooming image tool" openedx/edx-platform#31436

All set!

[feoh]

This is for openedx/wg-build-test-release#398 since I'm unsure whether the issue got linked previously.

[sarina]

Suggest collapsing "Instructor Experiences" and "Learner Experiences" sections to the following:

User Facing Experiences
*************************

See the :doc:`feature_release_notes` for more detail on user-facing changes in this release.

[feoh]

Suggest collapsing "Instructor Experiences" and "Learner Experiences" sections to the following:

User Facing Experiences
*************************

See the :doc:`feature_release_notes` for more detail on user-facing changes in this release.

All set! Almost missed this one since you're usually so awesome about enabling my laziness so I can just push the "Commit" button on this webpage :)

[sarina]

Suggested change

	No breaking changes in Sumac.

I would add this line IF it is true, because otherwise reading the rendered page it's a bit unclear how the headers nest. But I want to check in on this - @arbrandes @bradenmacdonald @regisb @feanil - no breaking changes in Sumac? Who else should I tag?

[bradenmacdonald]

@ormsbee or @kdmccormick ?

[sarina]

@feoh I didn't mean for you to commit this at this time. We need to check if there are any breaking changes.

[feoh]

Crap itchy trigger finger. Unresolving. Will fix if people find breaking changes.

[feoh]

@feoh I didn't mean for you to commit this at this time. We need to check if there are any breaking changes.

I know, I'm sorry :) I'll fix it if people raise anything but I'm not going to create a revision to fix a thing which in fact may not be broken :) I'll stay on top of this and ensure the page reflects reality. Sorry for prematurely pulling the trigger!

[feanil]

There is atleast openedx/edx-platform#35185 which should be captured here as a breaking change.

[bradenmacdonald]

@feanil That PR is not included in Sumac as far as I can tell.

[feanil]

Oh, you're right, it was merged just after. Right in that case, I think there is nothing that I'm aware of that's breaking in Sumac.

[pdpinch]

As part of the Oscare Ecommerce Stack deprecation, the following repositories have been archived:

• https://github.com/openedx/ecommerce
• https://github.com/openedx/ecommerce-worker
• https://github.com/openedx/frontend-app-payment
• https://github.com/openedx/frontend-app-ecommerce
• https://github.com/openedx/ecommerce-scripts

[sarina]

On Lines 5-6 there are dates for the release span (May 10 - October 23) - are those dates the accurate ones? @cmltaWt0 or @farhaanbukhsh ?

[sarina]

It looks like Sumac was cut on November 5th, and Redwood on May 10th. Unfortunately I can't make a suggestion here because the diff is too far up, but L6 should say

"to November 5, 2024"

@feoh