Skip to content

Commit 00aee00

Browse files
authored
docs: Add configuration update steps for theme hosting
Clarifies when to use tutor config save, tutor dev stop, and tutor dev start when updating theme variables. Adds step-by-step instructions to the documentation under the Static Hosting section.
1 parent 8aae940 commit 00aee00

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

plugins/tutor-contrib-paragon/README.rst

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,11 +186,41 @@ If `MFE_HOST_EXTRA_FILES` is set to `true`, the plugin:
186186

187187
Example URLs:
188188

189-
* Local LMS: `http://local.openedx.io/static/paragon/themes/light/light.min.css`
189+
* Local LMS: `http://apps.local.openedx.io/static/paragon/themes/light/light.min.css`
190190
* Dev server: `http://localhost:<PORT>/static/paragon/themes/dark/dark.min.css`
191191

192192
Each theme listed in `PARAGON_THEMES` is automatically exposed for use in MFEs.
193193

194+
Updating Theme Configuration
195+
============================
196+
197+
If you make changes to the theme list or other plugin variables, follow these steps to apply them correctly:
198+
199+
1. **Save the new configuration**
200+
201+
Use `tutor config save --set` to update your variables. For example:
202+
203+
.. code-block:: bash
204+
205+
tutor config save --set PARAGON_THEMES='["light", "dark"]'
206+
207+
2. **Restart the development environment**
208+
209+
After saving the configuration, restart Tutor to apply the changes:
210+
211+
.. code-block:: bash
212+
213+
tutor dev stop
214+
tutor dev start
215+
216+
3. **Verify the changes**
217+
218+
Check that the new themes are compiled and served correctly:
219+
220+
.. code-block:: bash
221+
222+
tutor local do paragon-build-tokens
223+
194224
Troubleshooting
195225
===============
196226

0 commit comments

Comments
 (0)