Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For each release, the document has sections for the different edX products affected. Typically a section for an edX product (Studio, LMS, Insights) contains information about new features or enhancements, issues with workarounds, and fixed bugs.

 Where 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.

The release master for edx-platform generates a wiki page that lists every commit included in a release. The dated list of LMS/Studio Release Pages provides links to these pages. 

Resources

Delivery

...

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

The doc team also publishes release announcements for each release on the edX partner portal and Open edX portal. The portals automatically send an email when the announcement is published (though the email may not arrive until several hours later).

For the mechanics of publishing the release notes and all guides affected by a release, and announcing the release, see:

...

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).

...

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

...

One documentation team member is responsible for writing the release notes each week. That writer works with the product managers to make sure that the included features and changes are described accurately and positioned appropriately.

...

.

Tools

Release notes use the edX wiki, Sublime (or another text editor), GitHub, and ReadTheDocs.

...