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

Set edx.org theme as default for edx-platform and MFEs #67

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

Conversation

mfarhan943
Copy link

Description:
Automate setting the edx.org theme as the default for both the edx-platform and MFEs during devstack provisioning.

Related Ticket:
edx/edx-arch-experiments#824

@mfarhan943 mfarhan943 self-assigned this Nov 6, 2024
options.mk Outdated
Comment on lines 95 to 98
# Set default theme for MFEs
ifndef PARAGON_BRAND_PACKAGE
PARAGON_BRAND_PACKAGE = edx/brand-edx.org
endif
Copy link
Member

Choose a reason for hiding this comment

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

Given MFEs can define the brand package (and its installed version) independently across each MFE, are there any alternative ways of setting the PARAGON_BRAND_PACKAGE on a per-MFE basis?

For example, frontend-app-learning might want to use v3 of the brand package whereas frontend-app-learner-dashboard might want v2. As is, I believe this would use the latest version of the package, regardless of compatibility with the consuming MFE. This MFE-specific support would largely reflect how brand package MFEs are configured via edx-internal today.

Perhaps each MFE configured via docker-compose.yml, extending microfrontend.yml, could define it as an environment variable that can be consumed by microfrontend.yml?

options.mk Outdated

# Set default theme for MFEs
ifndef PARAGON_BRAND_PACKAGE
PARAGON_BRAND_PACKAGE = edx/brand-edx.org
Copy link
Member

Choose a reason for hiding this comment

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

[curious] Should the PARAGON_BRAND_PACKAGE be defined as the full NPM module's name? It seems like the @ is concatenated within microfrontend.yml vs. included in the PARAGON_BRAND_PACKAGE definition.

Any reason this couldn't be @edx/brand-edx.org here, to representing the full NPM module name vs. splitting it across multiple files? For example, what if we ended up using a brand package that wasn't associated with an organization, i.e. not prefixed with @ (unlikely but demonstrates the question)?

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.

2 participants