wg-build-test-release icon indicating copy to clipboard operation
wg-build-test-release copied to clipboard

How Can We Make The Release Documentation Role More Tractable?

Open feoh opened this issue 1 year ago • 0 comments

The Problem

Right now, as I see it, there is a disconnect between the role as defined which involves authoring and creation of the release notes for each new OpenEdX release, and the context and expertise necessary to identify which PRs / Issues actually belong in said notes.

The release documentation role could be filled by anyone familiar with or willing to learn Git and ReStructured Text, but identifying appropriate context can only be done by OpenEdX developers, product managers, or others intimately familiar with OpenEdX features and components.

Proposed Solutions

  • Peter had two related suggestions I plan to implement
    • Timely reminders as the release approaches, signposting the Release Notes Wiki page and reminding folks that what's not on that page may not make it into the notes
    • An E-mail blast including all contributors to the current release signposting the wiki page

feoh avatar Oct 07 '24 15:10 feoh