-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Reorganize release notes display
As per mocks from early 2024, arrange the release notes such that the differences between the Dev/Operator RNs and the Product or Feature-based RNs is clear for the current and upcoming releases.
- Loading branch information
Showing
5 changed files
with
91 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,29 @@ | ||
Open edX Sumac Release | ||
###################### | ||
Open edX Sumac - The Next 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 | ||
******************* | ||
These are the release notes for the Sumac release, the 19th community release | ||
of the Open edX Platform, which will be released in December 2024. You can also review details | ||
about :doc:`index` or learn more about the `Open edX Platform`_. | ||
|
||
.. highlights:: | ||
|
||
Instructor Experiences | ||
********************** | ||
What's new in Sumac? Click to read about new features: | ||
|
||
:doc:`sumac/feature_release_notes`. | ||
|
||
Administrators & Operators | ||
************************** | ||
|
||
Settings and Toggles | ||
==================== | ||
.. highlights:: | ||
|
||
What's new in Sumac? Operators and developers, click to read about new | ||
updates, patches, and configuration options. | ||
|
||
:doc:`sumac/dev_op_release_notes`. | ||
|
||
Other Operator Changes | ||
====================== | ||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
Sumac Release Notes <sumac/feature_release_notes> | ||
Sumac Developer & Operator Release Notes <sumac/dev_op_release_notes> | ||
|
||
Deprecations & Removals | ||
*********************** | ||
|
||
|
||
Developer Experience | ||
******************** | ||
|
||
Researcher & Data Experiences | ||
***************************** | ||
|
||
.. _Open edX Platform: https://openedx.org | ||
|
||
Known Issues | ||
************ |
52 changes: 52 additions & 0 deletions
52
source/community/release_notes/sumac/dev_op_release_notes.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
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 :doc:`../index` or learn more about the `Open edX | ||
Platform`_. | ||
|
||
To view the end-user facing docs, see the :doc:`feature_release_notes`. | ||
|
||
.. _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 | ||
************ |
10 changes: 10 additions & 0 deletions
10
source/community/release_notes/sumac/feature_release_notes.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Open edX Redwood Release - Feature-Based Notes | ||
############################################## | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
|
||
Information for site operators and developers, including information on how to | ||
enable and/or configure new features that require additional work, can be found | ||
in the :doc:`dev_op_release_notes`. |