...
The change descriptions need to be put where the audience can make use of them. For developer-focused libraries, a changelog file in the repo is fine. For end-user feature descriptions, they’ll need to be published on Read The Docs or the partner portal.
...
Recommendations
Choose one of the following two processes:
Product-written feature notes
The product owner writes change descriptions in the existing Jira tickets for feature work. The team can review and contribute to these descriptions.
When
...
an Open edX release happens,
...
the product owner collects the descriptions and provides them in raw form to the Open edX release manager.
The Open edX release manager edits the information and publishes it on Read The Docs.
Engineer-written changelogs
Engineers write entries into repos' CHANGELOG files. Tools exist to make this easier to avoid merge conflicts.
...
For customers who are comfortable with it, the entries can be read directly in the repo
...
.
When an Open edX release happens, the release manager collects the information, edits it, and publishes it on Read The Docs.