diff --git a/source/community/release_notes/verawood/feature_release_notes.rst b/source/community/release_notes/verawood/feature_release_notes.rst index ff7e94d05..4eda6893c 100644 --- a/source/community/release_notes/verawood/feature_release_notes.rst +++ b/source/community/release_notes/verawood/feature_release_notes.rst @@ -14,6 +14,7 @@ Open edX Verawood Release - Product Release Notes lti_notifications verawood_lti_cert copyright_acceptance + verawood_frontend_plugin_slots Information for site operators and developers, including information on how to enable and/or configure new features that require additional work, can be found diff --git a/source/community/release_notes/verawood/verawood_frontend_plugin_slots.rst b/source/community/release_notes/verawood/verawood_frontend_plugin_slots.rst new file mode 100644 index 000000000..d386f51c1 --- /dev/null +++ b/source/community/release_notes/verawood/verawood_frontend_plugin_slots.rst @@ -0,0 +1,140 @@ +.. _Verawood Frontend Plugin Slots: + +New Frontend Plugin Slots for the Verawood Release +################################################## + +Utilizing *frontend plugin slots*, site operators now have the ability to +customize various portions of the site. + +A “frontend plugin slot” refers to an area of a web page - comprising one or +more visual elements - that can be “swapped out” with other visual elements. For +example, one plugin slot allows you to remove the "Help" button in the header. + +Overhead and hassle is minimized using the plugin slot system. Site operators +can leverage a plugin slot using a configuration file; the codebase does not +need to be copied (“forked”) nor are extensive changes needed. A snippet of code +is all that is needed to use a plugin slot. A site operator places that code +within a configuration file. Site operators should refer to the +``src/plugin-slots`` directory within each MFE's codebase to view documentation +for that MFE's plugin slot(s). + +In these release notes, we'll detail the new and updated plugin slots found in the Ulmo +release. The full list of existing plugin slots can be found in +:ref:`Available Frontend Plugin Slots`, and usage instructions are +available at :ref:`Use A Frontend Plugin Framework Slot`. + +.. contents:: + :local: + :depth: 1 + +Where possible, descriptions of the plugin slots are provided. Click the name of +the slot to be brought to the documentation page which contains example +screenshots. + +Note: Instance operators using these slots will need to use their +fully-qualified slot id provided in the descriptions, such as +``org.openedx.frontend.authoring.course_unit_sidebar.v1``. + +frontend-app-authoring +********************** + +**Added:** + +- `org.openedx.frontend.authoring.page_banner.v1 + `_: + This slot wraps the Paragon ```PageBanner`` component to allow plugins to replace, + modify, or hide the banner shown on pages like Schedule & Details. By default, + it renders the standard ``PageBanner`` with the provided props and children. + +frontend-app-discussions +************************ + +**Added:** + +- `org.openedx.frontend.layout.header_discussions.v1 + `_: + This slot is used to replace/modify/hide the discussions header. + +frontend-app-learning +********************* + +**Added:** + +- `org.openedx.frontend.learning.course_tab_links.v1 + `_: + This slot is used to replace/modify/hide the course tabs. +- `org.openedx.frontend.learning.course_tabs_navigation.v1 + `_: + This slot is used to replace/modify/hide the entire course tab navigation. +- `org.openedx.frontend.learning.learner_tools.v1 + `_: + This plugin slot provides a location for learner-facing tools and features to + be displayed during course content navigation. The slot is rendered via a + React portal to ``document.body`` to ensure proper positioning and stacking + context. + +**Updated:** + +See `ADR-10 Extract Update Widget from Core MFE +`_ +for more detail. + +- `NotificationTraySlot + `_ + is now `org.openedx.frontend.learning.upgrade_panel.v1 + `_ +- `NotificationsDiscussionsSidebarSlot + `_ + is now `org.openedx.frontend.learning.right_sidebar.v1 + `_ +- `NotificationsDiscussionsSidebarTriggerSlot + `_ + is now `org.openedx.frontend.learning.right_sidebar_trigger.v1 + `_ + +**Removed:** + +- `NotificationWidgetSlot `_ + + +frontend-app-instructor-dashboard +********************************** + +This repository is new as of Verawood, and is enabled by default. It can be optionally disabled; see the :ref:`Verawood operator notes `. + +**Added:** + +- `CourseInfoSlot + `_: + The content of this slot renders the current course's organization, course + number, and title next to the site logo while a user is on any instructor + dashboard page, giving instructors an at-a-glance reminder of the course they + are working in. +- `EnrollmentActionsSlot + `_: + This slot is used to replace/modify/hide the action buttons in the header of + the Enrollments tab. By default it renders Add Beta Testers and Enroll + Learners with no permission gating, so out of the box the behavior is + unchanged. +- `PlaceholderSlot + `_: + A placeholder for adding new tabs & routes to the instructor dashboard. Both + slots ship empty. The instructor dashboard already renders a built-in set of + tabs (Course Info, Enrollments, Course Team, Cohorts, Grading, etc.); these + slots exist so a site operator can add new tabs alongside them. + +.. seealso:: + + * :ref:`Use A Frontend Plugin Framework Slot` + + * :ref:`Frontend Slots Learner Dash (Sumac)` + + * :ref:`Frontend Slots Header (Sumac)` + +**Maintenance chart** + ++--------------+-------------------------------+----------------+------------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+------------------------------------+ +| 2026-07-30 | Frontend WG | Verawood | Pass | ++--------------+-------------------------------+----------------+------------------------------------+ \ No newline at end of file diff --git a/source/community/release_notes/verawood/verawood_marketing_notes.rst b/source/community/release_notes/verawood/verawood_marketing_notes.rst index 5daae0624..83281cb84 100644 --- a/source/community/release_notes/verawood/verawood_marketing_notes.rst +++ b/source/community/release_notes/verawood/verawood_marketing_notes.rst @@ -63,6 +63,10 @@ We encourage operators to enable frontend-base on staging or sandbox instances and provide feedback on the `Open edX forums `_. +:ref:`More Flexibility To Build Custom Features `: More +plugin slots have been added across the platform to support easier customization +and extension by your development or operations team. + 🔮 Upcoming in Willow (December 2026) **************************************