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.

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

Merged
merged 37 commits into from
Dec 16, 2024
Merged

Sumac Release Notes #622

merged 37 commits into from
Dec 16, 2024

Conversation

feoh
Copy link
Contributor

@feoh feoh commented Nov 22, 2024

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 openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 22, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 22, 2024

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:

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
Copy link
Contributor

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
Copy link
Contributor Author

feoh commented Dec 3, 2024

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
Copy link
Contributor

sarina commented Dec 4, 2024

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

@pdpinch
Copy link
Contributor

pdpinch commented Dec 10, 2024

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

@feoh
Copy link
Contributor Author

feoh commented Dec 10, 2024

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

All set!

@feoh feoh closed this Dec 10, 2024
@feoh feoh reopened this Dec 10, 2024
feoh and others added 3 commits December 10, 2024 16:03
Great informational additions on Mellisearch and indexing/upgrades. Thank you!

Co-authored-by: Braden MacDonald <mail@bradenm.com>
Naming changes. Thank you!

Co-authored-by: Braden MacDonald <mail@bradenm.com>
Content libraries info updates. Thank you!

Co-authored-by: Braden MacDonald <mail@bradenm.com>
@feoh feoh changed the title VERY EARLY swing at Sumac Release Notes (Incomplete) Sumac Release Notes Dec 10, 2024
Co-authored-by: Braden MacDonald <mail@bradenm.com>
@feoh feoh marked this pull request as ready for review December 10, 2024 22:05
@feoh feoh self-assigned this Dec 10, 2024
@feoh
Copy link
Contributor Author

feoh commented Dec 10, 2024

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

@feoh
Copy link
Contributor Author

feoh commented Dec 11, 2024

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 :)

Yay no breaking changes!

Co-authored-by: Sarina Canelake <sarina@axim.org>
Disambiguate Mellisearch as a requirement.

Co-authored-by: Braden MacDonald <mail@bradenm.com>
feoh and others added 2 commits December 12, 2024 09:32
@sarina sarina enabled auto-merge (rebase) December 16, 2024 18:26
@sarina sarina merged commit b86f181 into openedx:main Dec 16, 2024
2 checks passed
Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

👍🏼

- The programs_listing endpoint in the credentials application has been removed. `[DEPR]: /program-listing endpoint <https://github.com/openedx/credentials/issues/2642>`_.
- The skill_level endpoint has been removed `[DEPR]: endpoint /user/v1/skill_level/{job_id}/ <https://github.com/openedx/edx-platform/issues/35302>`_.
- [UPCOMING] The Toggle 'block_structure.storage_backing_for_cache' will be removed, with a default setting of True. You may want to test enabling in Sumac before it becomes the default behavior in Teak. See `[DEPR]: block_structure.storage_backing_for_cache in edx-platform <https://github.com/openedx/public-engineering/issues/32>`_.
- As part of the `Oscare Ecommerce Stack deprecation <https://github.com/openedx/public-engineering/issues/22>`_ , the following repositories have been archived:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- As part of the `Oscare Ecommerce Stack deprecation <https://github.com/openedx/public-engineering/issues/22>`_ , the following repositories have been archived:
- As part of the `Oscar Ecommerce Stack deprecation <https://github.com/openedx/public-engineering/issues/22>`_ , the following repositories have been archived:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This PR is already over the fence but I'll fix this in a new one and AT you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.