Skip to content

Commit

Permalink
Sumac Product Release Notes Framework (#578)
Browse files Browse the repository at this point in the history
* Sumac - Product Release Notes Framework

Page organization for the upcoming Sumac release

* Add teaser for Aspects Dashboard

* Clarify name of Dev/Op Rel Notes

* Update Aspects Dash to Aspects Course Comparison Dash

* Adjust language on blank Teak pages
  • Loading branch information
sarina authored Oct 2, 2024
1 parent b366d7e commit 3645cf2
Show file tree
Hide file tree
Showing 17 changed files with 126 additions and 9 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion source/community/release_notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ migrations, and other changes and updates to the Open edX platform.
:maxdepth: 2

Redwood: The Current Release <redwood>
Sumac: The Next Release <sumac>
Sumac: December 2024 Release <sumac>
Teak: June 2025 Release <teak>

.. toctree::
:maxdepth: 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Open edX Redwood Release - Feature-Based Notes

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`.
in the :doc:`Developer & Operator Release Notes<dev_op_release_notes>`.
11 changes: 11 additions & 0 deletions source/community/release_notes/sumac/aspects_comp_dashboard.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Aspects Course Comparison Dashboard
###################################

The Product and Engineering Teams from eduNEXT and Axim Collaborative are
excited to introduce a new Aspects Dashboard for course administrators with the
upcoming Sumac Release! The new Course Comparison Dashboard will allow users to
easily compare courses and runs by enrollment, number of active users,
high-level performance and video engagement metrics. We've also made
improvements to existing course-level dashboards to make them easier to use.

The Open edX Sumac release comes out in December 2024.
8 changes: 8 additions & 0 deletions source/community/release_notes/sumac/customizing_pages.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Customizing Site Header and Learner Dashboard
#############################################

Coming soon in Sumac: leverage *frontend plugin slots* to quickly and easily
modify visual elements on the site header and on the Learner Dashboard. Be sure
to watch this page for more detail!

The Open edX Sumac release comes out in December 2024.
12 changes: 6 additions & 6 deletions source/community/release_notes/sumac/dev_op_release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Open edX Sumac Release
######################
Open edX Sumac Developer & Operator Release Notes
#################################################

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 23, 2024.
You can also review details about :doc:`../index` or learn more about the `Open edX
Platform`_.
These are the developer & operator release notes for the Sumac release, the 19th
community release of the Open edX Platform, spanning changes from May 10, 2024
to October 23, 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`.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
Open edX Redwood Release - Feature-Based Notes
Open edX Sumac Release - Product Release Notes
##############################################

.. toctree::
:maxdepth: 1

customizing_pages
aspects_comp_dashboard

Information for site operators and developers, including information on how to
enable and/or configure new features that require additional work, can be found
Expand Down
29 changes: 29 additions & 0 deletions source/community/release_notes/teak.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Open edX Teak - June 2025 Release
#################################

These are the release notes for the Teak release, the 20th community release
of the Open edX Platform, which will be released in June 2025. You can also review details
about :doc:`index` or learn more about the `Open edX Platform`_.

.. highlights::

What's new in Teak? Click to read about new features:

:doc:`teak/feature_release_notes`.


.. highlights::

What's new in Teak? Operators and developers, click to read about new
updates, patches, and configuration options.

:doc:`teak/dev_op_release_notes`.

.. toctree::
:maxdepth: 2

Teak Release Notes <teak/feature_release_notes>
Teak Developer & Operator Release Notes <teak/dev_op_release_notes>

.. _Open edX Platform: https://openedx.org

54 changes: 54 additions & 0 deletions source/community/release_notes/teak/dev_op_release_notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
Open edX Teak Developer & Operator Release Notes
################################################

*Releasing June, 2025!*

These are the developer & operator release notes for the Teak release, the 20th
community release of the Open edX Platform, spanning changes from October 24,
2024 to April 9, 2025. 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
************
12 changes: 12 additions & 0 deletions source/community/release_notes/teak/feature_release_notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Open edX Teak Release - Product Release Notes
#############################################

*Releasing June, 2025!*

.. 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 3645cf2

Please sign in to comment.