Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How Can We Make The Release Documentation Role More Tractable? #396

Open
feoh opened this issue Oct 7, 2024 · 0 comments
Open

How Can We Make The Release Documentation Role More Tractable? #396

feoh opened this issue Oct 7, 2024 · 0 comments
Labels
retrospective Action items from previous release retrospectives.

Comments

@feoh
Copy link

feoh commented Oct 7, 2024

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
@mariajgrimaldi mariajgrimaldi added the retrospective Action items from previous release retrospectives. label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
retrospective Action items from previous release retrospectives.
Projects
Status: No status
Development

No branches or pull requests

2 participants