Skip to content
Closed
2 changes: 1 addition & 1 deletion source/community/release_notes/dogwood.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ enhancement also gives system administrators the ability to configure a list of
file types that learners cannot upload.

For more information, see
Configuring ORA2 to Prohibit Submission of File Types.
:ref:`Configuring ORA2 to Prohibit Submission of File Types`.

Certificates
============
Expand Down
2 changes: 1 addition & 1 deletion source/community/release_notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ migrations, and other changes and updates to the Open edX platform.
Release Version Info
====================

The :doc:`named_release_branches_and_tags` page is a quick reference for site
The :ref:`Named Release Branches and Tags` page is a quick reference for site
operators that details installation information for the current and previous
releases. Note that the latest release is the only supported release. We
currently do not have the ability to support more than one release at a time.
4 changes: 2 additions & 2 deletions source/community/release_notes/juniper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Open edX Juniper Release
The Juniper release is the 10th named release of the Open edX Platform and our
largest yet. Our previous release (Ironwood) was released in January 2019, so
Juniper spans January 2019 through May 2020. You can also review details about
`earlier releases`_ or learn more about the `Open edX Platform`_ if you are new to
:ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_ if you are new to
Open edX. Below is a summary of the changes for each of the main platform
areas, along with a way to jump down to each section of the release notes.

.. _earlier releases: https://docs.openedx.org/en/latest/community/release_notes/index.html

.. _Open edX Platform: https://open.edx.org

.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions source/community/release_notes/koa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Open edX Koa Release
####################

These are the release notes for the Koa release, the 11th community release of the Open edX Platform, spanning changes from May 23 to November 12 2020. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_ if you are new to Open edX.
These are the release notes for the Koa release, the 11th community release of the Open edX Platform, spanning changes from May 23 to November 12 2020. You can also review details about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_ if you are new to Open edX.


.. _earlier releases: https://docs.openedx.org/en/latest/community/release_notes/index.html
.. _Open edX Platform: https://open.edx.org

.. contents::
Expand Down
8 changes: 4 additions & 4 deletions source/community/release_notes/lilac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Open edX Lilac Release
######################

These are the release notes for the Lilac release, the 12th community release of the Open edX Platform, spanning changes from November 12 2020 to April 9 2021. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_.
These are the release notes for the Lilac release, the 12th community release of the Open edX Platform, spanning changes from November 12 2020 to April 9 2021. You can also review details about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_.


.. _earlier releases: https://docs.openedx.org/en/latest/community/release_notes/index.html
.. _Open edX Platform: https://open.edx.org

.. contents::
Expand Down Expand Up @@ -59,7 +59,7 @@ When a learner reaches the end of the course, they will see a new navigation but

The 3-day Streak Milestone is live and celebrates learners who engage with their course on 3 consecutive days. It also provides normative insights into how learners’ behavior connects to successful course outcomes. (TBD Image)

See https://docs.openedx.org/projects/edx-platform/en/latest/featuretoggles.html#featuretoggle-FEATURES['ENABLE_MILESTONES_APP'] for information on how to turn on and configure these Milestones features.
See :ref:`edx-platform:featuretoggles` ['ENABLE_MILESTONES_APP'] for information on how to turn on and configure these Milestones features.

Mobile Experience
=================
Expand Down Expand Up @@ -154,7 +154,7 @@ Course Upsell Messaging and Payment
Settings and Toggles Documentation
==================================

Documentation for settings and toggles is much improved, but still incomplete. See https://docs.openedx.org/projects/edx-platform/en/latest/index.html
Documentation for settings and toggles is much improved, but still incomplete. See :ref:`edx-platform:featuretoggles`.

New settings introduced in Lilac include:

Expand Down
9 changes: 4 additions & 5 deletions source/community/release_notes/maple.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Open edX Maple Release
######################

These are the release notes for the Maple release, the 13th community release of the Open edX Platform, spanning changes from April 9 2021 to October 15 2021. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_.
These are the release notes for the Maple release, the 13th community release of the Open edX Platform, spanning changes from April 9 2021 to October 15 2021. You can also review details about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_.


.. _earlier releases: https://docs.openedx.org/en/latest/community/release_notes/index.html
.. _Open edX Platform: https://open.edx.org

.. contents::
Expand Down Expand Up @@ -36,13 +36,12 @@ Studio login changed to OAuth

In versions prior to Maple, Studio (CMS) shared a session cookie with the LMS, and redirected to the LMS for login.
Studio is changing to become an OAuth client of the LMS, using the same SSO configuration that other IDAs use. (See
`ARCHBOM-1860`_; `OEP-42`_) This is a breaking change. Follow the `Studio OAuth migration runbook`_ as part of
`ARCHBOM-1860`_; :doc:`openedx-proposals:best-practices/oep-0042-bp-authentication`) This is a breaking change. Follow the `Studio OAuth migration runbook`_ as part of
upgrading to Maple. For devstack, run::

./provision-ida-user.sh studio studio 18010

.. _ARCHBOM-1860: https://openedx.atlassian.net/browse/ARCHBOM-1860
.. _OEP-42: https://docs.openedx.org/projects/openedx-proposals/en/latest/best-practices/oep-0042-bp-authentication.html
.. _Studio OAuth migration runbook: https://github.com/openedx/edx-platform/blob/open-release/maple.master/docs/guides/studio_oauth.rst

django-cors-headers version updgraded
Expand Down Expand Up @@ -352,7 +351,7 @@ See the sections above on OAuth and Certificates.
Settings and Toggles
====================

Documentation for settings and toggles is much improved, but still incomplete. See https://docs.openedx.org/projects/edx-platform/en/latest/index.html
Documentation for settings and toggles is much improved, but still incomplete. See :ref:`edx-platform:featuretoggles`.


Dependency updates
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Named Release Branches and Tags:

Site Operators: Named Release Branches and Tags
###############################################

Expand Down
8 changes: 3 additions & 5 deletions source/community/release_notes/nutmeg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Open edX Nutmeg Release
#######################

These are the release notes for the Nutmeg release, the 14th community release of the Open edX Platform, spanning changes from October 15 2021 to April 11 2022. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_.
These are the release notes for the Nutmeg release, the 14th community release of the Open edX Platform, spanning changes from October 15 2021 to April 11 2022. You can also review details about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_.


.. _earlier releases: https://docs.openedx.org/en/latest/community/release_notes/index.html
.. _Open edX Platform: https://openedx.org

.. contents::
Expand Down Expand Up @@ -58,9 +58,7 @@ The Dates Tab has also been removed from the legacy learner experience. It is on
Weekly Course Goals
===================

The old course goals feature has been replaced with a new weekly learning goals feature. Users set a goal for how frequently they want to learn per course and get reminder emails about their goals. See `Enabling the Weekly Learning Goals Feature`_ for instructions on how to configure this feature and more details on how the feature works. The new weekly learning goals feature is controlled with the same flag as the previous course goals feature.

.. _Enabling the Weekly Learning Goals Feature: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_weekly_learning_goals.html
The old course goals feature has been replaced with a new weekly learning goals feature. Users set a goal for how frequently they want to learn per course and get reminder emails about their goals. See :ref:`Enabling the Weekly Learning Goals Feature` for instructions on how to configure this feature and more details on how the feature works. The new weekly learning goals feature is controlled with the same flag as the previous course goals feature.

Learning Micro-Frontend (MFE)
=============================
Expand Down
6 changes: 3 additions & 3 deletions source/community/release_notes/olive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Open edX Olive Release
######################

These are the release notes for the Olive release, the 15th community release of the Open edX Platform, spanning changes from April 11 2022 to October 11 2022. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_.
These are the release notes for the Olive release, the 15th community release of the Open edX Platform, spanning changes from April 11 2022 to October 11 2022. You can also review details about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_.


.. _earlier releases: https://docs.openedx.org/en/latest/community/release_notes/index.html
.. _Open edX Platform: https://openedx.org

.. contents::
Expand Down Expand Up @@ -158,7 +158,7 @@ MFE runtime configuration support

Where up until Nutmeg it was only possible to change a micro-frontend's settings at build time, it is now possible to do so at both server *and* browser runtime via a new configuration mechanism. In addition to the added convenience, this significantly reduces the frequency at which MFE container images need to be rebuilt. Many operators will never have to build them to begin with, as pre-built ones can be (and are) provided, thus saving up precious time and resources on deployment.

This behavior is optional and controlled by the :code:`ENABLE_MFE_CONFIG_API` Django setting in the LMS, and the :code:`APP_ID` and :code:`MFE_CONFIG_API_URL` MFE build-time settings. The actual runtime configuration can then be specified via the :code:`MFE_CONFIG` and :code:`MFE_CONFIG_OVERRIDES` variables in the LMS. (These can also be overridden via `site configuration <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/sites/configure_site.html>`_, with the effect that such configuration can be changed dynamically via the backing database.) For more details, refer to the `corresponding architecture decision record <https://github.com/openedx/edx-platform/blob/open-release/olive.master/lms/djangoapps/mfe_config_api/docs/decisions/0001-mfe-config-api.rst>`_.
This behavior is optional and controlled by the :code:`ENABLE_MFE_CONFIG_API` Django setting in the LMS, and the :code:`APP_ID` and :code:`MFE_CONFIG_API_URL` MFE build-time settings. The actual runtime configuration can then be specified via the :code:`MFE_CONFIG` and :code:`MFE_CONFIG_OVERRIDES` variables in the LMS. (These can also be overridden via :ref:`Configuring Sites Independently`, with the effect that such configuration can be changed dynamically via the backing database.) For more details, refer to the `corresponding architecture decision record <https://github.com/openedx/edx-platform/blob/open-release/olive.master/lms/djangoapps/mfe_config_api/docs/decisions/0001-mfe-config-api.rst>`_.

.. _upgrade-note:

Expand Down
7 changes: 3 additions & 4 deletions source/community/release_notes/palm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Open edX Palm Release - Developer & Operator Notes
##################################################

These are the release notes for the Palm release, the 16th community release of the Open edX Platform, spanning changes from October 11, 2022, to April 11, 2023. You can also review details about `earlier releases`_ or learn more about the `Open edX Platform`_.
These are the release notes for the Palm release, the 16th community release of the Open edX Platform, spanning changes from October 11, 2022, to April 11, 2023. You can also review details about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_.


.. _earlier releases: https://docs.openedx.org/en/latest/community/release_notes/index.html
.. _Open edX Platform: https://openedx.org

.. contents::
Expand Down Expand Up @@ -42,8 +42,7 @@ Ecommerce is still officially deprecated and we continue to work on the `Ecommer
Developer changes
=================

The old developer documentation site has been deprecated and removed. Please use `Open edX Developers - Latest
Documentation <https://docs.openedx.org/en/latest/developers/index.html>`_ instead.
The old developer documentation site has been deprecated and removed. Please use :ref:`Developer's Home` instead.

The modules :code:`tutor.hooks.actions`, :code:`tutor.hooks.filters`, and :code:`tutor.hooks.contexts` are no longer
part of the Tutor API. This change should not affect most developers, who only use the :code:`Actions` and
Expand Down
2 changes: 1 addition & 1 deletion source/community/release_notes/quince.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To learn more about this upgrade, visit the `wiki page <https://openedx.atlassia
Instructor Experiences
**********************

* `Copy and Paste For Course Content <https://docs.openedx.org/en/open-release-quince.master/educators/how-tos/copy_paste_course_components.html>`__
* :ref:`Copy and Paste Course Components`

Administrators & Operators
**************************
Expand Down
3 changes: 1 addition & 2 deletions source/community/release_notes/quince/woocommerce.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ See a demo of the plugin here:

If you're interested in the WooCommerce integration, you can now activate `this
plugin`_ in your WordPress site and connect your Open edX instance with your
WordPress! `Additional documentation can be found here`_.
WordPress! Additional documentation can be found here: :doc:`wordpress-ecommerce-plugin:index`

This integration can serve as a model for integrating with other ecommerce
platforms in a standard and supportable way. For further details on the project
Expand All @@ -40,7 +40,6 @@ work itself, you can check out:
.. _deprecation: https://github.com/openedx/public-engineering/issues/22
.. _ecommerce repo: http://github.com/openedx/ecommerce/
.. _this plugin: https://edunext-docs-openedx-woocommerce-plugin.readthedocs-hosted.com/en/latest/plugin_quickstart.html#add-the-plugin-settings
.. _Additional documentation can be found here: https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/index.html
.. _#33006: https://github.com/openedx/edx-platform/pull/33006
.. _#33059: https://github.com/openedx/edx-platform/pull/33059
.. _Project discovery documentation: https://docs.google.com/document/d/1gImq4DFy3B_JSZlH3tCj5bmPQXji0OCnw1SbGB8bVxw/edit?usp=sharing
Loading