...
...
...
...
For features released from edx-platform and other repos, the release notes writer works with the product managers to decide on what will be included in the weekly release notes, and to make sure that the included features and changes are described accurately and positioned appropriately.
The source files for edX release notes are in the edx-documentation/en-us/release_notes folder.
Process
...
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.
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.
...
.
- Writer reviews the LMS/Studio Release Pages wiki page and asking works with the product team for itemsto determine release notes content.
- Doc team 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, create writer creates a pull request and tag tags Development, Product, PM, and PM team Training team members, asking for review and collaboration.
- Development, Product, PM, and Training teams can comment or make updates as necessaryreview 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.
...