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

docs: add dev note about feature toggles #1694

Merged
merged 4 commits into from
Jan 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/developers_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <env> 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.
Expand Down
Loading