Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated header note to link to new release notes area
Note

Note As of the week of February 13, the product team produces release notes. See: 2017 - Release Notes


Audience: Partner and Open edX course teams, Open edX system administrators, Open edX developers, researchers

...

Children Display
depth2
sorttitle
excerptTypesimple

Introduction

Release notes provide regular information to partner institutions and the Open edX community, including course teams, system administrators, and developers, about the latest updates to the platform. Many users see release notes as the primary way to stay up to date on platform developments.

...

In addition to posting the release notes at docs.edx.org, the documentation team publishes a portal announcement that abridges the release notes. The portal announcement is available on the partner and Open edX portals, and is also sent via e-mail to portal subscribers.

Content

Release notes are organized first by date, with the most recent date first. They are also organized by product.

...

Where applicable, JIRA IDs are included for internal reference. For information about how to add JIRA references, see Cross-References to JIRA in the EdX Style Guide.

Delivery

The release notes are available as an HTML page through the Release Notes link on the docs.edx.org index page.

...

The 1. Writing Release Notes page contains a step-by-step description of the process by which the doc team has historically created release notes.

Frequency

Release notes are produced to accompany each release of the edX platform. Publication of the release notes and all guides with release-related updates occurs as soon as feasible after the release "goes live on prod" (that is, it is in production on edx.org).

Changes made to other repos, including the edx-analytics-dashboard (Insights), the mobile apps, IDAs, and ORA2, are released on other schedules. Those changes are included in the next release notes, which might therefore follow the software release by a week or even more.

Update Documentation 

The process for creating or updating the release notes is outlined on the 1. Writing Release Notes page.

Tools

Release notes use the edX wiki, Sublime (or another text editor), GitHub, and ReadTheDocs. For more information, see 1. Writing Release Notes.

The release portal announcement uses the partner and Open edX portals. For more information, see 3. Publishing the Release Portal Announcement.

Open edX Releases

For Open edX releases beginning with Dogwood, the Open Source team is responsible for identifying all of the additions and changes to document in the release notes. This effort includes asking engineers to identify features and updates that have an impact on the next named release on a wiki page, and going through release notes written for edX platform releases since the last named release to identify what to include. This work for named releases can also uncover changes that have not yet been documented. 

...