How-to: port a frontend plugin from FPF to frontend-base#1459
Open
arbrandes wants to merge 1 commit into
Open
Conversation
sarina
reviewed
May 14, 2026
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | | | | | |
Contributor
There was a problem hiding this comment.
Before merge please fill this in :)
|
|
||
| See :doc:`../references/frontend-plugin-slots` for a list of available slots. | ||
|
|
||
| :doc:`port-frontend-plugin-to-frontend-base` |
Contributor
There was a problem hiding this comment.
Please use :ref: syntax as it's more robust than :doc: (I'm slowly changing this throughout this repo but it's taking awhile) - if you could fix all usages of this in your diff that'd be swell!
Adds a site-ops how-to that walks plugin authors through porting both halves (npm package + Tutor plugin) of an existing frontend-plugin-framework contribution to frontend-base, with translation tables for imports, slot ops, slot ids, and tutor-mfe patches. Cross-linked from the existing use-frontend-plugin-slots page. Co-Authored-By: Claude <noreply@anthropic.com>
arbrandes
force-pushed
the
arbrandes/port-frontend-plugin-to-frontend-base
branch
from
8d4f865 to
6142d48
Compare
Contributor
|
@arbrandes - the build broke due to upstream changes, if you pull in main the issues have been resolved. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Adds a site-ops how-to that walks plugin authors through porting both halves of an existing frontend-plugin-framework contribution (the npm package and the accompanying Tutor plugin) to frontend-base. The page lives at
source/site_ops/how-tos/port-frontend-plugin-to-frontend-base.rstand is picked up automatically by the directory's glob toctree.The page covers what changes in the architecture, then provides translation tables for imports (
@edx/frontend-platform→@openedx/frontend-base,getConfig()→getSiteConfig()), slot operations (PLUGIN_OPERATIONS→WidgetOperationTypes), slot ids (default_contents→defaultContent, etc.), and tutor-mfe patch names (mfe-env-config-buildtime-imports→mfe-site-config-imports, etc.). It also documents the compat-shim escape hatch (FRONTEND_COMPAT_PLUGINS,FRONTEND_COMPAT_SLOTS) for plugins that can't be ported immediately, with a callout thatsource-based installs need a workingbuildscript since tutor-mfe runsturbo run buildagainst workspace packages but does no transpilation otherwise.The existing
use-frontend-plugin-slots.rst(FPF flow) gets a.. note::at the top and a matchingseealsoentry pointing at the new page, so readers landing on the legacy how-to are directed to the modern path.A worked example referenced from the doc is the
frontend-basebranch ofopenedx/sample-plugin.LLM usage notice
Built with assistance from Claude.