Skip to content

Commit

Permalink
docs: Reorganize release notes display
Browse files Browse the repository at this point in the history
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
sarina committed Jul 15, 2024
1 parent 4a93992 commit f5f1697
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 40 deletions.
8 changes: 5 additions & 3 deletions source/community/release_notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ migrations, and other changes and updates to the Open edX platform.
un-supported release to the toctree in the old_releases.rst file.
.. toctree::
:maxdepth: 1
:maxdepth: 2

Redwood: The Current Release <redwood>
Redwood Release Notes <redwood/feature_release_notes>
Redwood Developer & Operator Release Notes <redwood/dev_op_release_notes>
Sumac: The Next Release <sumac>

.. toctree::
:maxdepth: 1

old_releases
named_release_branches_and_tags

Expand Down
6 changes: 6 additions & 0 deletions source/community/release_notes/redwood.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,10 @@ about :doc:`index` or learn more about the `Open edX Platform`_.

:doc:`redwood/dev_op_release_notes`.

.. toctree::
:maxdepth: 2

Redwood Release Notes <redwood/feature_release_notes>
Redwood Developer & Operator Release Notes <redwood/dev_op_release_notes>

.. _Open edX Platform: https://openedx.org
55 changes: 18 additions & 37 deletions source/community/release_notes/sumac.rst
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 source/community/release_notes/sumac/dev_op_release_notes.rst
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 source/community/release_notes/sumac/feature_release_notes.rst
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`.

0 comments on commit f5f1697

Please sign in to comment.