[Proposal] Release Notes

[cablaa77]

Abstract

This is an MVP Release Notes feature in which the course authors can access Release Notes, which will be updates on new features and functionalities in edX. The user will be able to access the Release Notes from edXStudio. There is also just a question as to whether this would be of value to the openedX community, and we would love to hear feedback in regard to that.

Detailed Product Proposal

https://openedx.atlassian.net/wiki/spaces/OEPM/blog/2025/09/29/5260967967/Proposal+Release+Notes

Context & Background (in brief, if a Product Proposal is linked above)

For edX, there is no real communication tool that product managers have to communicate updates. edX Partners frequently express frustration about “not knowing what has been released.” This lack of visibility creates friction in adoption and undermines trust.

Scope & Approach (in brief, if a Product Proposal is linked above)

This workstream is intended to impact all course authors and administrators. The aim is to give each of them the opportunity to clearly understand what has been released and the value proposition that the new functionality is intended to provide.

Value & Impact (in brief, if a Product Proposal is linked above)

Mostly this will be measured qualitatively. The feedback we have received has been consistent. We will continue to gather feedback once the feature is rolled out. The value to the platform is that there will be increased awareness in terms of updates across all course teams, enabling them to be aware of how to create better learning experiences more efficiently.

Milestones and/or Epics

This workstream is not broken into milestones, but the parts of the workstream include

• In the footer of edX Studio pages, course team members can find a link to Release Notes that takes them to a new webpage. The desired outcome is improved comms in regard to new features as well as features that are either coming soon, in beta, and so on.

• Release Notes creates the ability to post and edit updates for specific edX internal users as well as creates ability for course team members to read updates.

• New posts should

Be visible for anyone who is a course team member for at least 1 course (no ability to post for specific users or specific roles e.g. admins only see this)
Have editable date and time that post will be published
Default date is the current date and time
Have a field for title of the post
Have a field in which user can write the release note/update
Button to post the release note/update or cancel

• After posting, specific individuals should be able to edit or delete their post. By default, leave the original publish date the same. But the poster can edit the date if they want.

• Include the ability to subscribe, which would lead to receiving an email whenever a new post was published

• Put the "creation of a post" idea behind a waffle flag that is limited to specific people.

• APIs:

GET(to get response for whole page)
CRUD operations for a post on release notes page (Their request body and response)

Named Release

Verawood

Timeline (in brief, if a Product Proposal is linked above)

rollout expected in Q4 2025

Proposed By

2U

Additional Info

We are proposing that the Release Notes page and capability will be made available in the openedX project, so that any instance can post their instances specific release notes. This would mean that we contribute the page and the backing database table, but not the records that are in 2U’s database table.

[github-actions]

Thanks for your submission, @openedx/openedx-product-managers will review shortly.

[ali-hugo]

@cablaa77 Thank you for submitting the Release Notes proposal; I think it would be a great addition to the Open edX community!

I’ve assigned the ticket to myself because I’m working on a related proposal that would benefit from many of the features Release Notes would introduce. I see there’s already a good amount of feedback, but if there’s anything specific you’d like input on, please let me know and I’ll try to gather it.

[ali-hugo]

@cablaa77 @sarina I've moved this ticket to "being developed" based on this conversation on the proposal. Please adjust if this is not correct.

---

EDIT:
On second thought, this is only "being developed" for edX right, so doesn't really belong in the same category on the Open edX backlog? I've moved it to "in review" for now.

[sarina]

Adolfo's comments about plugins haven't been responded to yet.

[ali-hugo]

Adolfo's comments about plugins haven't been responded to yet.

@jristau1984 Could you weigh in on the conversation about plugins please (I think it's this thread)? A few comments have been added since you last posted.

[jristau1984]

Adolfo's comments about plugins haven't been responded to yet.

@jristau1984 Could you weigh in on the conversation about plugins please (I think it's this thread)? A few comments have been added since you last posted.

I have responded to all open comments.

[ali-hugo]

That was fast - thanks @jristau1984! I spotted one comment that still needs a response. The comment is mine, and I think I know the answer, but would like your confirmation please.

[jristau1984]

That was fast - thanks @jristau1984! I spotted one comment that still needs a response. The comment is mine, and I think I know the answer, but would like your confirmation please.

replied.