Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
4 changes: 2 additions & 2 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
4 changes: 2 additions & 2 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
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
27 changes: 16 additions & 11 deletions source/community/release_notes/redwood/aspects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ How can I find Aspects Reports?
Accessing course-level dashboards from the LMS
==============================================

Once Aspects has been installed, users can easily `access Aspects Reports <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/access_aspects.html>`_ for a
Once Aspects has been installed, users can easily :doc:`openedx-aspects:course_team/how-tos/access_aspects` for a
course directly from the Open edX LMS by clicking on a new Reports link on the
Instructor Dashboard. There's no need to navigate elsewhere to gain valuable
insight into exactly what's going on in a course:

.. image:: /_images/release_notes/redwood/aspects_screenshot2.png

On the Reports tab in the LMS, users can navigate between three new dashboards:
a `course dashboard <https://docs.openedx.org/projects/openedx-aspects/en/latest/reference/course_overview_dashboard.html>`_, `at risk learners dashboard <https://docs.openedx.org/projects/openedx-aspects/en/latest/reference/learner_groups_dashboard.html>`_, and `individual learner dashboard <https://docs.openedx.org/projects/openedx-aspects/en/latest/reference/individual_learner_dashboard.html>`_. These dashboards were
a :doc:`openedx-aspects:reference/course_overview_dashboard`, :doc:`openedx-aspects:reference/learner_groups_dashboard`, and :doc:`openedx-aspects:reference/individual_learner_dashboard`. These dashboards were
designed specifically for course authors and course teams looking to access
quick and easy-to-glean engagement, enrollment, and performance data from their
courses:
Expand All @@ -43,13 +43,15 @@ Accessing all Aspects has to offer from Superset
================================================

Course delivery team members who plan to view information for one course and
then another may chose to `navigate to Superset <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/access_aspects.html>`_, a third-party data
then another may chose to :doc:`openedx-aspects:course_team/how-tos/access_aspects`, a third-party data
visualization tool used to create and display Aspects dashboards and charts.
This will allow these users to easily view the three out-of-the-box course-level
dashboards for one of their courses and followed by another and another.

Site operators and superusers can view data about any course on their Open edX
instance or their whole Open edX instance in Superset. `Users can access Superset directly via a link from the Aspects Reports in the LMS <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/access_aspects.html>`_ using single sign-on authorization via their LMS account credentials:
instance or their whole Open edX instance in Superset.
Users can access Superset directly via a link from the Aspects Reports in the LMS
(:doc:`openedx-aspects:course_team/how-tos/access_aspects`) using single sign-on authorization via their LMS account credentials:

.. image:: /_images/release_notes/redwood/aspects_screenshot4.png

Expand Down Expand Up @@ -92,7 +94,7 @@ course where learner engagement drops off:

.. image:: /_images/release_notes/redwood/aspects_screenshot8.png

When `cross filtered <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/cross_filter.html>`_ by a single
When cross filtered (:doc:`openedx-aspects:course_team/how-tos/cross_filter`) by a single
course video, the Watched Video Segment graphs can help course authors and teams
pinpoint potentially unclear video timestamp ranges:

Expand All @@ -109,8 +111,9 @@ Individual and At-Risk Learner Dashboards
=========================================

In addition to course-wide data, Aspects Reports surface course activity data
for `individual learners <https://docs.openedx.org/projects/openedx-aspects/en/latest/reference/individual_learner_dashboard.html>`_ and
`learners that may be at risk of not completing the course <https://docs.openedx.org/projects/openedx-aspects/en/latest/reference/learner_groups_dashboard.html>`_ based on a set of predefined
for individual learners (:doc:`openedx-aspects:reference/individual_learner_dashboard`) and
learners that may be at risk of not completing the course
(:doc:`openedx-aspects:reference/learner_groups_dashboard`) based on a set of predefined
risk factors. The at-risk learner group is made up of learners that have
enrolled in the course, done something in the course other than visit the course
outline page, have not yet passed the course, and have not visited the course in
Expand All @@ -119,7 +122,7 @@ seven or more days.
When installing the plugin, site operators can choose whether or not to show
limited personally identifiable information (PII) to course delivery teams. On
Open edX instances that show limited PII to course delivery teams, staff and
admin users can see and `download <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/download_reports.html>`_ the names, usernames, and email
admin users can see and :doc:`openedx-aspects:course_team/how-tos/download_reports` the names, usernames, and email
addresses of individual and at-risk learners making targeted communication and
learner intervention possible.

Expand All @@ -137,7 +140,7 @@ view detailed information:
Add filters to a dashboard
==========================

Users can `add filters <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/apply_filters_lms.html#>`_ to an
Users can :doc:`openedx-aspects:course_team/how-tos/apply_filters_lms` to an
Aspects dashboard using the filters panel on the side of each dashboard. Hover
over the filter icon on the upper corner of a table or chart to view what
filters were applied to create the data visualization on any dashboard:
Expand All @@ -148,7 +151,7 @@ Dive deeper into the data with interactive charts that can be cross-filtered
============================================================================

All Aspects Dashboards allow users to dig deeper into their data through
`cross filters <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/cross_filter.html>`_. With
:doc:`openedx-aspects:course_team/how-tos/cross_filter`. With
cross-filters, a user can apply the same filter to multiple charts and tables in
a dashboard at once. For example, if a user adds a cross-filter for a single
video on the Video Engagement tab of the Course Dashboard, all applicable video
Expand All @@ -159,7 +162,9 @@ tables and charts will update to show data only for that video:
Download tables and images from Aspects dashboards
==================================================

Users can easily `download the data used to create any chart or table in an Aspects dashboard in tabular format as a CSV or Excel file <https://docs.openedx.org/projects/openedx-aspects/en/latest/administator/how_to/export_tabular_data.html>`_ or `download the table or chart as an image <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/download_reports.html>`_ for use in their own
Users can easily download the data used to create any chart or table in an Aspects dashboard in tabular format as a
CSV or Excel file (:doc:`openedx-aspects:administrator/how_to/export_tabular_data`) or download the table or chart as
an image (:doc:`openedx-aspects:course_team/how-tos/download_reports`) for use in their own
documents, presentations, or reports:

.. image:: /_images/release_notes/redwood/aspects_screenshot14.png
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ Open edX Redwood Release - Developer and Operator Release Notes

These are the Developer and Operator release notes for the Redwood release, the
18th community release of the Open edX Platform, spanning changes from October
10 2023 to May 09 2024. You can also review details about `earlier releases`_ or
10 2023 to May 09 2024. 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 @@ -352,14 +352,14 @@ Developer Experience
Researcher & Data Experiences
*****************************

`Aspects <https://docs.openedx.org/projects/openedx-aspects/en/latest/index.html>`_
:doc:`openedx-aspects:index`
is an analytics system for the Open edX platform, bringing actionable data
about course and learner performance to instructors and site operators. It is primarily
a Tutor plugin that ties together data from the Open edX learning management system
and Studio using open source tools to aggregate and transform learning traces into data
visualizations.

See the `Aspects configuration documentation <https://docs.openedx.org/projects/openedx-aspects/en/latest/technical_documentation/how-tos/production_configuration.html>`_
See the :doc:`openedx-aspects:technical_documentation/how-tos/production_configuration`
to learn about setting up Aspects for your production environment.

Known Issues
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Content Libraries Redesign Beta:

Content Libraries Redesign - Beta
#################################

Expand Down
Loading