WIP: Add a custom theme to edxapp LMS #105
Closed
Conversation
This file contains 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
The theme is added in a build step specific to each customer upon deployment. The same build will be used to add functionalities on the common image that are either specific to our OpenShift deployment (e.g. adding Datadog monitoring) our specific to a customer (theme). It is a good idea to use a common image stream for the CMS and the LMS even if no customization is made because it allows keeping a copy of the image in our local registry and avoid downloading it from Doker Hub upon each deployment.
This was referenced Aug 28, 2018
jmaupetit
changed the title
sampaccoud
commented
Aug 28, 2018
| USER 0 | ||
| {% if edxapp_theme_url is defined and edxapp_theme_url %} | ||
| COPY . /edx/app/edxapp/edx-platform/themes/custom-theme | ||
| NO_PREREQ_INSTALL=1 DEFAULT_SITE_THEME="custom-theme" paver update_assets --settings={{ edxapp_build_settings }} --skip-collect |
There was a problem hiding this comment.
@jmaupetit in fact, I think it might not be required to set DEFAULT_SITE_THEME since "update_assets" builds all the themes in the themes directory...
Maybe try removing it as it would be simpler... and we wouldn't need to modify the build settings in fun-platform like I did...
3 tasks
jmaupetit
added a commit
that referenced
this pull request
Sep 4, 2018
This work adapts @sampaccoud's work on #105 to add customizable themes for the LMS. We've added an example for patient0/development with a public theme cooked by the Racoongang team.
3 tasks
jmaupetit
added a commit
that referenced
this pull request
Sep 4, 2018
This work adapts @sampaccoud's work on #105 to add customizable themes for the LMS. We've added an example for patient0/development with a public theme cooked by the Racoongang team.
jmaupetit
added a commit
that referenced
this pull request
Sep 4, 2018
This work adapts @sampaccoud's work on #105 to add customizable themes for the LMS. We've added an example for patient0/development with a public theme cooked by the Racoongang team.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose
Adding a custom theme to an Open edX site must be done upon deployment and not in the common Docker image because it is specific to each customer.
edit: this PR is depends on #111
Proposal
We propose to use OpenShift's buildconfig objects to automate such builds. The same mechanism can be used to add monitoring or other build steps that are specific either to our way to deploy things to OpenShift or to a customer (like the theme).
It is a good idea to use a common image stream for the CMS and the LMS even if no customization is made because it allows keeping a copy of the image in our local registry and avoid downloading it
from DockerHub upon each deployment.