From 70d4d2015ff94c8fd3e7619e17be1e85339fb31c Mon Sep 17 00:00:00 2001 From: Nathan Sprenkle Date: Tue, 7 Sep 2021 16:39:34 -0400 Subject: [PATCH] docs: add note about feature toggles --- docs/developers_guide.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/developers_guide.rst b/docs/developers_guide.rst index 6b79609e47..d244336525 100644 --- a/docs/developers_guide.rst +++ b/docs/developers_guide.rst @@ -42,6 +42,13 @@ This must be done from inside either lms or studio docker container. In order to simulate a given tox environment (django18, django111, quality, js), run tox -e for the env in question (after re-activating your edx-ora2 virtual environment). Usually, you can just run the underlying make commands for quicker tests, as requirements aren't re-installed. +Enabling/disabling features +--------------------------------------- +ORA code observes several feature toggles for enabling/disabling functionality. For +development purposes, these can be enabled locally in your ``edx-platform`` instance +or in ``/settings/base.py``. See ``settings/base.py`` for ORA-specific toggles and +linked documentation. + Working with submission dependencies ------------------------------------ ORA code also depends on edx-submissions. As a result, anytime a new version of edx-submissions is released, ORA code must be updated as follows. @@ -96,9 +103,9 @@ This is required if there were any JS changes: - ``make lms-restart studio-restart`` - **NOTE**: cms does not support hot reload at the moment -Minifying css +Minifying CSS ----------------- -This is required if there were any scss changes: +This is required if there were any SCSS changes: - be inside the shell - ``cd /edx/src/edx-ora2``