Introduction
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.
For features released from other repos, the product managers and doc team members work together to decide on what will be included in the weekly release notes.
The source files for edX release notes are in the edx-documentation/en-us/release_notes folder.
Process
The Documentation team drafts the release notes by making a new branch off of master. Development, product, and PMs review and revise the notes as necessary through a GitHub pull request.
- Doc team identifies release notes content by reviewing the LMS/Studio Release Pages wiki page and asking the product team for items.
- Doc team creates a draft of release notes. The team also adds the file on the index.rst page.
- When the draft is as complete as possible, create a pull request and tag Development, Product, and PM team members, asking for review and collaboration.
- Development, Product, PM, and Training teams can comment or make updates as necessary.
- 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.