From 280f8e157736991c529525d61c3bb18a80ff8b72 Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Tue, 6 Apr 2021 11:05:44 -0400 Subject: [PATCH] docs: improve CourseWaffleFlag admin docs Improve the docs for how to configure CourseWaffleFlag overrides via Django admin. ARCHBOM-1721 --- openedx/core/djangoapps/waffle_utils/__init__.py | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/openedx/core/djangoapps/waffle_utils/__init__.py b/openedx/core/djangoapps/waffle_utils/__init__.py index 02cc5140a0..2c977dcdcc 100644 --- a/openedx/core/djangoapps/waffle_utils/__init__.py +++ b/openedx/core/djangoapps/waffle_utils/__init__.py @@ -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):