Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #27260 from edx/robrap/improve-course-override-docs

Browse Source 
ARCHBOM-1721: docs: improve CourseWaffleFlag admin docs
This commit is contained in:
Robert Raposa
2021-04-06 12:28:12 -04:00
committed by GitHub
parent 9b4f19f204 280f8e1577
commit 29c98511eb
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
openedx/core/djangoapps/waffle_utils/__init__.py
View File

@@ -33,8 +33,17 @@ class CourseWaffleFlag(LegacyWaffleFlag):
SOME_COURSE_FLAG.is_enabled(course_key)
The Django Admin "waffle_utils" section can be used to configure a course override for this same flag (e.g.
my_namespace.some_course_feature).
To configure, go to "Waffle flag course overrides" under the Django Admin "waffle_utils" section.
Waffle flag: Set this to the flag name (e.g. my_namespace.some_course_feature).
Course id: Set this to the course id (e.g. course-v1:edx+100+Demo)
Override choice: (Force on/Force off). "Force on" will enable the waffle flag for all users in a course,
overriding any behavior configured on the waffle flag itself. "Force off" will disable the waffle flag
for all users in a course, overriding any behavior configured on the waffle flag itself. Requires
"Enabled" (see below) to apply.
Enabled: This must be marked as enabled in order for the override to be applied. These settings can't be
deleted, so instead, you need to disable if it should no longer apply.
"""
def _get_course_override_value(self, course_key):