Skip to content

Conversation

@MaxFrank13
Copy link
Member

@MaxFrank13 MaxFrank13 commented Jul 15, 2025

This updates the PARAGON_BRAND_PACKAGE field for most of our MFE services. This field is used when bringing up the service to determine what the @edx/brand package should be aliased to.

By default, the @edx/brand package is aliased to the open source brand (@openedx/brand-openedx). In our Stage and Production environments, we alias the package to point to the private 2u/edX theme. Previously this was @edx/brand-edx.orgthe old theme. We have now switched to @edx/elm-theme — the new theme. The old theme does not support design tokens, which were introduced in Paragon v23 as the method for theming Paragon components. Without a brand package that provides design tokens, MFE builds will fail if they are using the latest code from master branches. Elm theme supports design tokens.

All master branches of the Open edX supported MFEs have been updated to Paragon v23 and now require design token support from the brand package.

It is worth noting that the configuration for 4 MFEs has been left unchanged in this PR. They are:

  • frontend-app-library-authoring — this is a deprecated MFE so will most likely be removed from devstack soon
  • frontend-app-payment — using a fork that is not fully caught up with the master branch; will soon be replaced by Commercetools checkout page from commerce coordinator application
  • frontend-app-learning — using a fork that is not fully caught up with the master branch
  • frontend-app-program-console — using a fork that is not fully caught up with the master branch

Until the forked repositories have been upgraded to Paragon v23 and have support for design tokens, the configuration can not be changed. Dev builds would fail if we try to use @edx/elm-theme without that support.

Testing instructions

  • Pull down this branch
  • Pick an MFE to test — ex. Learner Dashboard
  • Run make dev.remove-containers.frontend-app-learner-dashboard to bring down the service (if it's already running)
  • Run make dev.up.frontend-app-learner-dashboard
  • Make sure you are logged in (localhost:18000) and then go to localhost:1996 to view the dashboard
  • If you are enrolled in a course, you should see something that looks like this:
Screenshot 2025-07-15 at 12 06 53 PM

If you want to test what it looked like before

You can either:

  • Switch to the master branch

OR

THEN,

  • Bring the service down (make dev.remove-containers.frontend-app-learner-dashboard)
  • Bring the service back up (make dev.remove-containers.frontend-app-learner-dashboard)
  • Check the dashboard at localhost:1996 and you should see the old theme (see image below)
Screenshot 2025-07-15 at 10 31 05 AM

I've completed each of the following or determined they are not applicable:

  • Made a plan to communicate any major developer interface changes (or N/A)

@MaxFrank13 MaxFrank13 merged commit bbfa2e8 into master Jul 15, 2025
19 checks passed
@MaxFrank13 MaxFrank13 deleted the mfrank/update-docker-theme-to-elm branch July 15, 2025 19:16
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