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

Temporarily Re-Introduce Studio Maintenance Announcements #36107

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented Jan 14, 2025

Description

This PR has two commits:

  • The first commit is a straight revert of fix: Remove pointless Maintenance and Announcement apps #35852, which removed both parts of the Studio Maintenance dashboard (Announcements and Force-Publish-Course).
  • The second commit then re-removes Force-Publish-Course, because it has been broken since the moment it was merged into the platform.

The net result is that we are temporarily re-introducing just the Announcements tool within the Studio Maintenance dashboard, as well as the "Maintenance" link in the Studio header. The "Maintenance" link in the MFE header will be re-introded in a quick follow-up PR, which also needs review and approval: openedx/frontend-component-header#565

Supporting information

See discussion: #35852 (comment)

Screenshots & testing instructions

Set FEATURES['ENABLE_ANNOUNCEMENTS'] = True, and then disable the learner home MFE via waffle (/admin/waffle/flag/?q=learner_home_mfe).

image

Go to the restored maintenance dashboard in Studio. Notes:

  • Until the linked header PR is merged, the only way to get to this page from the authoring MFE is to type the URL in: <CMS_BASE>/maintenance.
  • Notice that the "Edit Announcements" option has been restored, but the old broken "Force Publish Course" option has not been restored.

image

Create few new announcements. Make at least one active, and one inactive:

image

Ensure the active ones show up on the legacy learner dashboard (at <LMS_BASE>/):

image

Please note that the janky image and text formatting was an existing behavior, and is part of why we desire to remove this feature from the platform soon.

@kdmccormick kdmccormick marked this pull request as draft January 14, 2025 20:39
@kdmccormick kdmccormick force-pushed the revert-35852-kdmccormick/cms-maintenance-depr branch from d5b8d3a to 2f57a9d Compare January 15, 2025 14:23
@kdmccormick kdmccormick force-pushed the revert-35852-kdmccormick/cms-maintenance-depr branch from 93ec261 to 23fe895 Compare February 14, 2025 22:26
@kdmccormick kdmccormick changed the title revert: fix: Remove pointless Maintenance and Announcement apps Temporarily Re-Introduce Studio Maintenance Announcements Feb 14, 2025
@kdmccormick kdmccormick added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Feb 14, 2025
@kdmccormick kdmccormick marked this pull request as ready for review February 14, 2025 22:40
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@kdmccormick kdmccormick force-pushed the revert-35852-kdmccormick/cms-maintenance-depr branch from 23fe895 to 38254dd Compare February 17, 2025 13:40
@kdmccormick kdmccormick marked this pull request as draft February 17, 2025 13:55
@kdmccormick
Copy link
Member Author

Converting back to draft since the announcements don't seem to be showing up on the learner dashboard for some reason...https://pr-36107-139931.sandboxes.opencraft.hosting/dashboard

@Agrendalath , if you see something obviously wrong with this, let me know. Otherwise I'll try to fix it later today or tomorrow.

@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@kdmccormick
Copy link
Member Author

Ah, I need to turn on ENABLE_ANNOUNCEMENTS

@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@kdmccormick kdmccormick removed the create-sandbox open-craft-grove should create a sandbox environment from this PR label Feb 18, 2025
@kdmccormick kdmccormick force-pushed the revert-35852-kdmccormick/cms-maintenance-depr branch from 38254dd to d8c77fa Compare February 18, 2025 16:56
@kdmccormick kdmccormick marked this pull request as ready for review February 18, 2025 16:56
@kdmccormick
Copy link
Member Author

@Agrendalath OK, this is actually ready now. The PR sandbox is not working, but I have verified the change locally and included screenshots.

Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kdmccormick, thank you for preparing this!

👍

  • I tested this: verified that the announcements can be edited in Studio and are displayed correctly on the legacy dashboard
  • I read through the code
  • I checked for accessibility issues: n/a
  • Includes documentation: n/a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants