Note: While the writer is writing the release notes, another member of the team tests the context-sensitive links in Studio and the LMS. For more information, see the following pages. |
|---|
The process for creating or updating release notes is the process outlined on the Creating and Updating Documentation page, with the additional steps outlined below.
- Writer reviews the LMS/Studio Release Pages wiki page and works with the product team to determine release notes content.
- Writer creates a draft of the release notes. The team also adds the file on the index.rst page.
Note: The source files for edX release notes are in the edx-documentation/en-us/release_notes folder. - When the draft is as complete as possible, writer creates a pull request and tags Development, Product, PM, and Training team members, asking for review and collaboration.
- Development, Product, PM, and Training teams review and revise the release notes, making sure that the included features and changes are described accurately and positioned appropriately.
- Doc team drafts an announcement for the partner and Open edX portals for review by another doc team member. The portal announcement is an abridged version of the release notes.
- Doc team merges the pull request. If changes come in after this point, the team will make every effort to get the change published as soon as possible.
- Doc team publishes the release notes and republishes all documents affected by the release by creating new builds of documentation projects on readthedocs.
- Doc team updates the release date on the docs.edx.org page and publishes the portal announcement on the partner and Open edX portals. The portals automatically send the announcement to subscribers as an email message.
Information on hotfixes will be rolled into the next version of release notes. If a hotfix is critical to include in release notes immediately, or for other urgent changes, email docs@edx.org.