-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
fix: Remove pointless Maintenance and Announcement apps #35852
fix: Remove pointless Maintenance and Announcement apps #35852
Conversation
This Studio Maintenance app has been broken for a long time, so it has been removed: openedx/edx-platform#35852
This Studio Maintenance app has been broken for a long time, so it is being removed from edx-platform: openedx/edx-platform#35852
b678bc7
to
9c556a1
Compare
This Studio Maintenance app has been broken for a long time, so it is being removed from edx-platform: openedx/edx-platform#35852
This Studio Maintenance app has been broken for a long time, so it is being removed from edx-platform: openedx/edx-platform#35852
This link is defined in frontend-component-header, so the message shouldn't be here. Anyway, we are deleting the link from frontend-component-header too Related: * openedx/frontend-component-header#553 * openedx/edx-platform#35852
...by bumping frontend-component-header 5.7.0 -> 5.8.0 Our reasoning is that the two functions of the Studio Maintenance dashboard (Announcements and Maintenance Banner) have been broken for a while. It's actually version 5.7.2 that removes the link [1] but since 5.8.0 has no breaking changes, it seemed prudent to jump straight to latest. [1] https://github.com/openedx/frontend-component-header/releases/v5.7.2 Related PR: openedx/edx-platform#35852
...by bumping frontend-component-header 5.7.0 -> 5.8.0 Our reasoning is that the two functions of the Studio Maintenance dashboard (Announcements and Maintenance Banner) have been broken for a while. It's actually version 5.7.2 that removes the link [1] but since 5.8.0 has no breaking changes, it seemed prudent to jump straight to latest. [1] https://github.com/openedx/frontend-component-header/releases/v5.7.2 Related PR: openedx/edx-platform#35852
The Studio Maintenance app had two features: * "Force Course Publish", which literally doesn't do anything. All it does is tell you what version *would* be seen by users *if* the course were to be published--no publishing actually occurs via this feature. * "Announcements", which writes to the announcements_announcement database table, but doesn't actually display anywhere. Having these pages in the platform is actively misleading and creates a maintenance burden for edx-platform developers, so we remove them. Note that this commit does not include a migration for the announcements Django app. So, announcements_announcement table will not be deleted. Given the small expected size of any past-authored announcements, we are not worried about leaving them in the database perpetually.
9c556a1
to
305a8c5
Compare
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
2U Release Notice: This PR has been deployed to the edX production environment. |
The Studio Maintenance app had two features: * "Force Course Publish", which literally doesn't do anything. All it does is tell you what version *would* be seen by users *if* the course were to be published--no publishing actually occurs via this feature. * "Announcements", which writes to the announcements_announcement database table, but doesn't actually display anywhere. Having these pages in the platform is actively misleading and creates a maintenance burden for edx-platform developers, so we remove them. Note that this commit does not include a migration for the announcements Django app. So, announcements_announcement table will not be deleted. Given the small expected size of any past-authored announcements, we are not worried about leaving them in the database perpetually.
The announcements are still displayed on the legacy dashboard when the Is there any existing alternative for displaying announcements to the learners in the Learner Dashboard MFE? If not, we could work on porting this solution to the MFE, as we still use this feature. |
Oh wow, I can't believe I missed that reference to the Announcements app 🤦🏻 Let me investigate alternatives. In the mean time, could you help me understand OC's usage of the feature? Only site-wide admins can add these messages, correct? |
@Agrendalath Friendly reminder on my question ^ |
@kdmccormick, sorry for missing your previous message. We use the announcements to provide general information for new learners, such as external links to the learning materials that are universal for the whole instance. |
@Agrendalath Got it. Aside from the lack of Studio UI for adding messages, it seems like the If the merge/migration is a viable path forward that we could achieve by the Teak cut, then would you need this PR reverted, or could we leave |
@kdmccormick, I agree - it sounds like a reasonable path for merging these two features.
We are still using the legacy pages for the Learner Dashboard and Studio, so we would need to revert at least a part of this PR unless we plan to implement it in both the Learning/Authoring MFE and legacy pages. We could help with the implementation using the CC hours. |
Description
The Studio Maintenance app had two features:
"Force Course Publish", which literally doesn't do anything. All it does is tell you what version would be seen by users if the course were to be published--no publishing actually occurs via this feature.
"Announcements", which writes to the announcements_announcement database table, but doesn't actually display anywhere.
Having these pages in the platform is actively misleading and creates a maintenance burden for edx-platform developers, so this commit removes them.
Note that this commit does not include a migration for the announcements Django app. So, announcements_announcement table will not be deleted. Given the small expected size of any past-authored announcements, we are not worried about leaving them in the database perpetually. (REVIEWERS: Let me know if you disagree with this.)
Testing Instructions
None
Merge considerations
Blocked by:
Other cleanup (non-blocking):
Supporting Info: Screenshots of the platform without this PR
Maintenance link in the Studio header
The "Maintenance Dashboard"
"Force Publish Course" not doing anything other than a dry run
"Announcements" that do not show up anywhere
Not even in the deprecated frontends!