fix: Remove pointless Maintenance and Announcement apps #35852
+5
−1,637
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kdmccormick
added a commit
to kdmccormick/frontend-component-header
that referenced
this pull request
Nov 14, 2024
This Studio Maintenance app has been broken for a long time, so it has been removed: openedx/edx-platform#35852
kdmccormick
added a commit
to kdmccormick/frontend-component-header
that referenced
this pull request
Nov 14, 2024
This Studio Maintenance app has been broken for a long time, so it is being removed from edx-platform: openedx/edx-platform#35852
This was referenced Nov 14, 2024
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.
kdmccormick
force-pushed
the
kdmccormick/cms-maintenance-depr
branch
from
b678bc7
to
9c556a1
Compare
kdmccormick
added a commit
to kdmccormick/frontend-component-header
that referenced
this pull request
Nov 14, 2024
This Studio Maintenance app has been broken for a long time, so it is being removed from edx-platform: openedx/edx-platform#35852
feanil
approved these changes
Nov 15, 2024
kdmccormick
added a commit
to openedx/frontend-component-header
that referenced
this pull request
Nov 15, 2024
This Studio Maintenance app has been broken for a long time, so it is being removed from edx-platform: openedx/edx-platform#35852
kdmccormick
added a commit
to openedx/frontend-app-authoring
that referenced
this pull request
Nov 15, 2024
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
kdmccormick
added a commit
to kdmccormick/frontend-app-course-authoring
that referenced
this pull request
Nov 21, 2024
...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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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!