docs: add theme hosting and URL configuration documentation#6
Closed
Ang-m4 wants to merge 1 commit intoafg/styles-hosting-setupfrom
Closed
docs: add theme hosting and URL configuration documentation#6Ang-m4 wants to merge 1 commit intoafg/styles-hosting-setupfrom
Ang-m4 wants to merge 1 commit intoafg/styles-hosting-setupfrom
Conversation
|
The documentation provided here is clear, structured, and highly informative. It explains not only how to enable the compiled theme hosting functionality via PARAGON_SERVE_COMPILED_THEMES, but also outlines how the system behaves across local and development environments, including precise URL examples. The breakdown of the PARAGON_THEME_URLS structure is especially helpful, covering core, defaults, and variant behavior in a way that's easy to understand and extend. This level of detail makes the setup approachable for new developers and ensures smooth integration with MFEs. Excellent job on providing practical, production-ready documentation. |
Author
|
Closing this PR as the new documentation will be handled in: openedx#39 |
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
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
This pull request updates the
plugins/tutor-contrib-paragon/README.rstfile to document new functionality for hosting and managing compiled themes in the Paragon plugin for Tutor. The changes focus on enabling static hosting of themes, configuring theme URLs, and providing a flexible structure for theme management.New Features for Theme Hosting and Configuration:
Static Hosting for Compiled Themes: Added support for serving compiled themes directly via an Nginx service. This can be enabled by setting
PARAGON_SERVE_COMPILED_THEMES = true. The service hosts themes from the path defined byPARAGON_COMPILED_THEMES_PATHand injects URLs into the LMS configuration under thePARAGON_THEME_URLSsetting. Only minified CSS files (*.min.css) are served.Environment-Specific Theme URLs: Documented how URLs are adjusted based on the environment:
Theme Configuration Structure:
PARAGON_THEME_URLSSetting: Detailed the structure of thePARAGON_THEME_URLSsetting in the LMSMFE_CONFIGdictionary, which includes:coresection for base styles.variantssection for all the themes.