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

[DEPR]: Studio Maintenance & Announcements Dashboard #36263

Open
1 task
kdmccormick opened this issue Feb 17, 2025 · 1 comment
Open
1 task

[DEPR]: Studio Maintenance & Announcements Dashboard #36263

kdmccormick opened this issue Feb 17, 2025 · 1 comment
Assignees
Labels
depr Proposal for deprecation & removal per OEP-21

Comments

@kdmccormick
Copy link
Member

kdmccormick commented Feb 17, 2025

Please first read the parent DEPR ticket, [DEPR]: All Legacy Studio Frontends.

Proposal Date

2025-02-19

Target Ticket Acceptance Date

2025-03-05

Earliest Open edX Named Release Without This Functionality

2025-09-08

Ulmo

Rationale

The Announcements tool is the only remaining tool in the Studio Maintenance dashboard (pictured below), which is one of the very few remaining legacy Studio frontends. To access it, go to Studio, your username in the top-right corner, and select "Maintenance":

image

The feature is very barebones. The announcements can only be created by org-wide staff, and they are only visible in one place (the legacy learner dashboard). The support a very limited amount of formatting, and the formatting does not always render very well (see below). They are visible to all users; no filtering or targeting is available.

image

By default, the announcements render nowhere. When FEATURES['ENABLE_ANNOUNCEMENTS'] is toggled on, they will render only on the legacy learner dashboard, (which is already deprecated, and can only be accessed by disabling the learner_home_mfe.enabled Waffle flag). The announcements do not render robustly or reactively; for example, see how an image within an announcement will overflow rather than resize:

image

In additional to the issues mentioned above, the feature is undocumented. Furthermore, it is is partially redundant: Site-wide announcements can also be served by the global status announcements app (/admin/status/globalstatusmessage/), (although those are also bare-bones and do not render in all the places that site operator might want them to).

Removing the Announcements tool will unblock us from entirely removing the legacy Studio frontend, which will significantly reduce maintenance burden, confusion, repeated work, and toil for edx-platform contributors.

Replacement

OpenCraft (@Agrendalath ) has tentatively volunteered to either (a) port the Announcement editor to frontend-app-authoring, or (b) merge the feature with one of the other announcement mechanisms in the platform.

However, we will plan to remove this frontend (and, if appropriate, its models) on August 2025, regardless of whether a replacement has been added.

Removal

  • The Studio Maintenance dashboard and the Edit Announcements frontends will both be removed from edx-platform.
  • The "Maintenance" link will be removed from the Studio header(s).
  • FEATURES['ENABLE_ANNOUNCEMENTS'] will be removed.
  • Unless it is used by the replacement ,openedx/features/announcements and its models will be removed.

Deprecation

We will ensure that the deprecation is noted in the Teak release notes. No code-level deprecation warnings will be raised.

Migration

TBD, dependent on Replacement plan.

Additional Info

Just to clarify any potential confusion: This feature was actually already removed because we thought it was unused. When a community member pointed out that the feature was in fact in use on some pages, we temporarily re-introduced it. We are now re-approaching its removal through the proper process (DEPR).

Task List

  • TBD
@github-actions github-actions bot added the depr Proposal for deprecation & removal per OEP-21 label Feb 17, 2025
@kdmccormick kdmccormick changed the title [DEPR]: Studio Announcements [DEPR]: Legacy Studio Maintenance dashboard and Announcements tool Feb 18, 2025
@kdmccormick kdmccormick changed the title [DEPR]: Legacy Studio Maintenance dashboard and Announcements tool [DEPR]: Studio Maintenance dashboard & Announcements tool Feb 18, 2025
@kdmccormick kdmccormick changed the title [DEPR]: Studio Maintenance dashboard & Announcements tool [DEPR]: Studio Maintenance & Announcements Dashboard Feb 18, 2025
@kdmccormick kdmccormick self-assigned this Feb 18, 2025
@robrap robrap moved this to Ready For Development in Arch-BOM Feb 19, 2025
@robrap robrap removed the status in Arch-BOM Feb 19, 2025
@kdmccormick kdmccormick moved this from Proposed to Communicated in DEPR: Deprecation & Removal Feb 19, 2025
kdmccormick added a commit to openedx/frontend-component-header that referenced this issue Feb 19, 2025
This reverts commit a229c34.

We are temporarily re-introducing the Maintenance link, as the Maintenance
Announcements tool is still in use, as discussed on:
openedx/edx-platform#35852

For more details, see the related edx-platform revert:
openedx/edx-platform#36107

In the future, this will be re-removed:
openedx/edx-platform#36263
@kdmccormick
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
depr Proposal for deprecation & removal per OEP-21
Projects
Status: Communicated
Development

No branches or pull requests

1 participant