nutmeg release notes

[pdpinch]

Nutmeg release notes.

part of openedx/wg-build-test-release#133

Date Needed (optional)

Nutmeg will be released on June 9, 2022

Reviewers

Possible roles follow. The PR submitter checks the boxes after each reviewer finishes and gives 👍.

• Subject matter expert: @sarina
• Subject matter expert: @feanil
• Subject matter expert: @nedbat
• Subject matter expert: @kdmccormick
• Doc team review (sanity check, copy edit, or dev edit?): @edx/doc
• Product review: @jmakowski1123
• PM review: n/a

@briangrossman @blarghmatey @shaidar

Testing

• Ran ./run_tests.sh without warnings or errors

HTML Version (optional)

• Build an RTD draft for your branch and add a link here: https://edx--2056.org.readthedocs.build/projects/open-edx-release-notes/en/2056/

Post-review

• Add a comment with the description of this change or link this PR to the next release notes task.
• Squash commits

[openedx-webhooks]

Thanks for the pull request, @pdpinch! I've created OSPR-6627 to keep track of it in JIRA, where we prioritize reviews. Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[pdpinch]

This is a very rough first pass. I have a couple of preliminary questions:

• Am I targeting the right branch?
• Will I get a readthedocs build?
• Does the basic structure make sense?

[nedbat]

@pdpinch It is amazing to have this happening so early in the process! A definite improvement over previous releases.

This is the section of the process about documentation: https://openedx.atlassian.net/wiki/spaces/COMM/pages/19662426/Process+to+Create+an+Open+edX+Release#Documentation

It says the release notes should be made on the master branch, and cherry-picked over to Nutmeg, so this should be a PR against master. This has the advantage of giving you a RTFD build.

[pdpinch]

@nedbat do you know why the github action is building edx-developer-guide and not open-edx-release-notes? Can I change what's built, or add to it?

[pdpinch]

Huh, I thought "squash" was an allowed commit message.

[nedbat]

@pdpinch it looks like the action does build the release notes: https://github.com/openedx/edx-documentation/runs/6115943991?check_suite_focus=true#step:6:2510 What makes you say it doesn't?

Oh: you mean it's not built on ReadTheDocs.... I'll look into that.

[nedbat]

I enabled pull request builds on ReadTheDocs for the release notes. It's a setting in the Advanced Settings for the project.

[openedx-webhooks]

Hello @pdpinch: We are unable to continue with review of your submission at this time. Please see the associated JIRA ticket for more explanation.

[pdpinch]

Thanks to @nedbat we now have a RTD build of this WIP PR: https://edx--2056.org.readthedocs.build/projects/open-edx-release-notes/en/2056/ (I also added a link to the description)

[sarina]

@pdpinch added some comments around "experimental" MFEs, which is too generous a term for where they're actually at.

[sarina]

@pdpinch could we move all the experimental features under one section, and also call them pre-alpha? Experimental to me implies there's a flag or setting that will turn them on. Beta even sounds more complete than where we're currently at. Enabling one of these MFEs would take a lot of work and it's undocumented. I recommend this structure:

Pre-Alpha Features
-------------------

The following Micro-frontends (MFEs) are in a "pre-alpha" state. They exist on GitHub but are not yet supported in Tutor. Additionally, they may lack key features such as support for theming, internationalization, and path-based deployments. We include mention of them because we expect all of them to be supported in the next release, Olive.

* `Authentication Micro-Frontend (MFE)`_
* `Discussions Micro-Frontend (MFE)`_
* `Course Authoring Micro-frontend (MFE)`_

.. _Authentication Micro-Frontend: https://github.com/openedx/frontend-app-authn
.. _Discussions Micro-Frontend (MFE): https://github.com/openedx/frontend-app-discussions
.. Course Authoring Micro-frontend (MFE): TBD

and please put this sub-section at the very bottom of this section (ie under Special Exams).

[pdpinch]

I agree with this approach, but I don't think they all belong within "Learner Experiences."

Given the challenge of enabling them, I put this at the end of the "Administrators & Operators" section.

[pdpinch]

@kdmccormick @regisb is this Ok? Or do you want to suggest more details?

[pdpinch]

I think this is ready to merge for the release. Let me know if/when I should squash the commits.

[ghassanmas]

There was the latest merge in nutmeg.master yesterday it resolved a minor bug. _ it fixes facebook sharing button in course about page_. for more context check test: openedx/wg-build-test-release/issues/174 PR: openedx/openedx-platform/pull/30518

[regisb]

I think this is ready to merge for the release. Let me know if/when I should squash the commits.

I think you should! Though I'm not quite sure how the docs are handled and at what point they get deployed to readthedocs.

[kdmccormick]

too many teams that sound like the "release" team: https://github.com/orgs/openedx/teams?query=release

Whoops, wrong issue.

[openedx-webhooks]

@pdpinch 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

[nedbat]

I've cherry-picked this (as commit 6364380) onto the Nutmeg branch.