Clarify many feature toggle annotations across all applications

eduNEXT · Sep 16, 2020 · a4ba4ae · a4ba4ae
1 parent fee9279
commit a4ba4ae
Show file tree

Hide file tree

Showing 24 changed files with 105 additions and 215 deletions.
diff --git a/cms/djangoapps/contentstore/config/waffle.py b/cms/djangoapps/contentstore/config/waffle.py
@@ -50,7 +50,7 @@ def waffle_flags():
 # .. toggle_implementation: WaffleFlag
 # .. toggle_default: False
 # .. toggle_description: Toggles the new micro-frontend-based implementation of the library authoring experience.
-# .. toggle_use_cases: incremental_release, open_edx
+# .. toggle_use_cases: temporary, open_edx
 # .. toggle_creation_date: 2020-08-03
 # .. toggle_target_removal_date: 2020-12-31
 # .. toggle_warnings: Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and ENABLE_LIBRARY_AUTHORING_MICROFRONTEND.

diff --git a/cms/envs/common.py b/cms/envs/common.py
@@ -341,9 +341,7 @@
     #   default because enabling allows a method to bypass password policy.
     # .. toggle_use_cases: open_edx
     # .. toggle_creation_date: 2020-02-21
-    # .. toggle_target_removal_date: None
     # .. toggle_tickets: 'https://github.com/edx/edx-platform/pull/21616'
-    # .. toggle_warnings: None
     'ENABLE_CHANGE_USER_PASSWORD_ADMIN': False,
 
     ### ORA Feature Flags ###
@@ -352,11 +350,11 @@
     # .. toggle_implementation: DjangoSetting
     # .. toggle_default: False
     # .. toggle_description: Set to True to enable team-based ORA submissions.
-    # .. toggle_use_cases: incremental_release
+    # .. toggle_use_cases: temporary
     # .. toggle_creation_date: 2020-03-03
     # .. toggle_target_removal_date: None
     # .. toggle_tickets: https://openedx.atlassian.net/browse/EDUCATOR-4951
-    # .. toggle_warnings: None
+    # .. toggle_warnings: This temporary feature toggle does not have a target removal date.
     'ENABLE_ORA_TEAM_SUBMISSIONS': False,
 
     # .. toggle_name: ENABLE_ORA_ALL_FILE_URLS
@@ -369,7 +367,7 @@
     # .. toggle_creation_date: 2020-03-03
     # .. toggle_target_removal_date: None
     # .. toggle_tickets: https://openedx.atlassian.net/browse/EDUCATOR-4951
-    # .. toggle_warnings: None
+    # .. toggle_warnings: This temporary feature toggle does not have a target removal date.
     'ENABLE_ORA_ALL_FILE_URLS': False,
 
     # .. toggle_name: ENABLE_ORA_USER_STATE_UPLOAD_DATA
@@ -381,7 +379,7 @@
     # .. toggle_creation_date: 2020-03-03
     # .. toggle_target_removal_date: None
     # .. toggle_tickets: https://openedx.atlassian.net/browse/EDUCATOR-4951
-    # .. toggle_warnings: None
+    # .. toggle_warnings: This temporary feature toggle does not have a target removal date.
     'ENABLE_ORA_USER_STATE_UPLOAD_DATA': False,
 
     # .. toggle_name: DEPRECATE_OLD_COURSE_KEYS_IN_STUDIO
@@ -392,7 +390,7 @@
     #      To disable, set to False.
     #      To enable with a custom support deadline, set to an ISO-8601 date string:
     #        eg: '2020-09-01'
-    # .. toggle_use_cases: incremental_release
+    # .. toggle_use_cases: temporary
     # .. toggle_creation_date: 2020-06-12
     # .. toggle_target_removal_date: 2020-12-01
     # .. toggle_warnings: This can be removed once support is removed for deprecated
@@ -404,7 +402,7 @@
     # .. toggle_implementation: DjangoSetting
     # .. toggle_default: False
     # .. toggle_description: Set to True to enable the Library Authoring MFE
-    # .. toggle_use_cases: incremental_release
+    # .. toggle_use_cases: temporary
     # .. toggle_creation_date: 2020-06-20
     # .. toggle_target_removal_date: 2020-12-31
     # .. toggle_tickets: https://openedx.atlassian.net/wiki/spaces/COMM/pages/1545011241/BD-14+Blockstore+Powered+Content+Libraries+Taxonomies
@@ -2261,7 +2259,7 @@
 # .. toggle_implementation: DjangoSetting
 # .. toggle_default: False
 # .. toggle_description: Toggle for removing the deprecated /signin url.
-# .. toggle_use_cases: incremental_release
+# .. toggle_use_cases: temporary
 # .. toggle_creation_date: 2019-12-02
 # .. toggle_target_removal_date: 2020-06-01
 # .. toggle_warnings: This url can be removed once it no longer has any real traffic.
@@ -2272,7 +2270,7 @@
 # .. toggle_implementation: DjangoSetting
 # .. toggle_default: False
 # .. toggle_description: Toggle for removing the deprecated /signup url.
-# .. toggle_use_cases: incremental_release
+# .. toggle_use_cases: temporary
 # .. toggle_creation_date: 2019-12-02
 # .. toggle_target_removal_date: 2020-06-01
 # .. toggle_warnings: This url can be removed once it no longer has any real traffic.

diff --git a/doc.rst.j2 b/doc.rst.j2
@@ -11,7 +11,6 @@ These are all of our well-documented feature toggles!
 {{ group.toggle_description }}
 
 * Type: {{ group.toggle_type[0] }}
-* Status: {{ group.toggle_status }}
 * Use cases: {{ group.toggle_use_cases|join(", ") }}
 {% if group.toggle_warnings != 'None' -%}
 * Warnings: {{ group.toggle_warnings }}

diff --git a/lms/djangoapps/bulk_email/models.py b/lms/djangoapps/bulk_email/models.py
@@ -485,12 +485,8 @@ class BulkEmailFlag(ConfigurationModel):
     .. toggle_description: If the flag is enabled, course-specific authorization is
       required, and the course_id is either not provided or not authorized, the feature
       is not available.
-    .. toggle_category: bulk email
     .. toggle_use_cases:  open_edx
     .. toggle_creation_date: 2016-05-05
-    .. toggle_target_removal_date: None
-    .. toggle_warnings: None
-    .. toggle_tickets: None
     """
     # boolean field 'enabled' inherited from parent ConfigurationModel
     require_course_email_auth = models.BooleanField(default=True)

diff --git a/lms/djangoapps/course_api/__init__.py b/lms/djangoapps/course_api/__init__.py
@@ -10,20 +10,16 @@
 # .. toggle_default: False
 # .. toggle_description: Waffle switch to enable the throttling of 2 requests/minute to the course API. For staff
 #   users, this limit is 10 requests/minute.
-# .. toggle_use_cases: open_edx
+# .. toggle_use_cases: circuit_breaker
 # .. toggle_creation_date: 2018-06-12
-# .. toggle_target_removal_date: None
-# .. toggle_warnings: None
 # .. toggle_tickets: https://openedx.atlassian.net/browse/LEARNER-5527
 USE_RATE_LIMIT_2_FOR_COURSE_LIST_API = WaffleSwitch(WAFFLE_SWITCH_NAMESPACE, 'rate_limit_2', __name__)
 # .. toggle_name: course_list_api_rate_limit.rate_limit_10
 # .. toggle_implementation: WaffleSwitch
 # .. toggle_default: False
 # .. toggle_description: Waffle switch to enable the throttling of 10 requests/minute to the course API. For staff
 #   users, this limit is 20 requests/minute.
-# .. toggle_use_cases: open_edx
+# .. toggle_use_cases: circuit_breaker
 # .. toggle_creation_date: 2018-06-12
-# .. toggle_target_removal_date: None
-# .. toggle_warnings: None
 # .. toggle_tickets: https://openedx.atlassian.net/browse/LEARNER-5527
 USE_RATE_LIMIT_10_FOR_COURSE_LIST_API = WaffleSwitch(WAFFLE_SWITCH_NAMESPACE, 'rate_limit_10', __name__)
diff --git a/lms/djangoapps/course_api/blocks/toggles.py b/lms/djangoapps/course_api/blocks/toggles.py
@@ -3,7 +3,7 @@
 """
 
 
-from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag, WaffleFlag, WaffleFlagNamespace
+from openedx.core.djangoapps.waffle_utils import WaffleFlag, WaffleFlagNamespace
 
 
 COURSE_BLOCKS_API_NAMESPACE = WaffleFlagNamespace(name=u'course_blocks_api')
@@ -12,11 +12,8 @@
 # .. toggle_implementation: WaffleFlag
 # .. toggle_default: False
 # .. toggle_description: Waffle flag to hide access denial messages in the course blocks.
-# .. toggle_use_cases: incremental_release, open_edx
-# .. toggle_creation_date: ??
-# .. toggle_target_removal_date: None
-# .. toggle_warnings: None
-# .. toggle_tickets: ??
+# .. toggle_use_cases: temporary, open_edx
+# .. toggle_warnings: This temporary feature toggle does not have a target removal date.
 HIDE_ACCESS_DENIALS_FLAG = WaffleFlag(
     waffle_namespace=COURSE_BLOCKS_API_NAMESPACE,
     flag_name=u'hide_access_denials',

diff --git a/lms/djangoapps/courseware/toggles.py b/lms/djangoapps/courseware/toggles.py
@@ -13,7 +13,7 @@
 # .. toggle_default: False
 # .. toggle_description: Waffle flag to redirect to another learner profile experience. Supports staged rollout to
 #   students for a new micro-frontend-based implementation of the courseware page.
-# .. toggle_use_cases: incremental_release, open_edx
+# .. toggle_use_cases: temporary, open_edx
 # .. toggle_creation_date: 2020-01-29
 # .. toggle_target_removal_date: 2020-12-31
 # .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and
@@ -29,7 +29,7 @@
 # .. toggle_description: Waffle flag to display a link for the new learner experience to course teams without
 #   redirecting students. Supports staged rollout to course teams of a new micro-frontend-based implementation of the
 #   courseware page.
-# .. toggle_use_cases: incremental_release, open_edx
+# .. toggle_use_cases: temporary, open_edx
 # .. toggle_creation_date: 2020-03-09
 # .. toggle_target_removal_date: 2020-12-31
 # .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and

diff --git a/lms/djangoapps/discussion/config/settings.py b/lms/djangoapps/discussion/config/settings.py
@@ -11,9 +11,6 @@
 #   for daily digest. This setting enables deprecation of daily digest.
 # .. toggle_use_cases: open_edx
 # .. toggle_creation_date: 2020-03-09
-# .. toggle_target_removal_date: None
-# .. toggle_tickets: None
-# .. toggle_warnings: None
 ENABLE_FORUM_DAILY_DIGEST = 'enable_forum_daily_digest'
 
 

diff --git a/lms/djangoapps/experiments/utils.py b/lms/djangoapps/experiments/utils.py
@@ -41,8 +41,8 @@
 # .. toggle_use_cases: temporary
 # .. toggle_creation_date: 2019-2-25
 # .. toggle_target_removal_date: None
-# .. toggle_warnings: None
 # .. toggle_tickets: REVEM-63, REVEM-198
+# .. toggle_warnings: This temporary feature toggle does not have a target removal date.
 PROGRAM_INFO_FLAG = WaffleFlag(
     waffle_namespace=experiments_namespace,
     flag_name=u'add_programs',
@@ -56,8 +56,8 @@
 # .. toggle_use_cases: temporary
 # .. toggle_creation_date: 2019-3-28
 # .. toggle_target_removal_date: None
-# .. toggle_warnings: None
 # .. toggle_tickets: REVEM-118
+# .. toggle_warnings: This temporary feature toggle does not have a target removal date.
 DASHBOARD_INFO_FLAG = WaffleFlag(experiments_namespace, u'add_dashboard_info', __name__)
 # TODO END: clean up as part of REVEM-199 (End)
 
@@ -69,8 +69,8 @@
 # .. toggle_use_cases: temporary
 # .. toggle_creation_date: 2020-7-7
 # .. toggle_target_removal_date: None
-# .. toggle_warnings: None
 # .. toggle_tickets: REV-1205
+# .. toggle_warnings: This temporary feature toggle does not have a target removal date.
 UPSELL_TRACKING_FLAG = WaffleFlag(
     waffle_namespace=experiments_namespace,
     flag_name=u'add_upsell_tracking',

diff --git a/lms/djangoapps/experiments/views_custom.py b/lms/djangoapps/experiments/views_custom.py
@@ -35,13 +35,11 @@
 # .. toggle_type: flag
 # .. toggle_default: False
 # .. toggle_description: Toggle mobile upsell enabled
-# .. toggle_category: experiments
 # .. toggle_use_cases: temporary
 # .. toggle_creation_date: 2019-09-05
 # .. toggle_target_removal_date: None
-# .. toggle_warnings: None
 # .. toggle_tickets: REV-934
-# .. toggle_status: supported
+# .. toggle_warnings: This temporary feature toggle does not have a target removal date.
 MOBILE_UPSELL_FLAG = WaffleFlag(
     waffle_namespace=WaffleFlagNamespace(name=u'experiments'),
     flag_name=u'mobile_upsell_rev934',

diff --git a/lms/djangoapps/verify_student/toggles.py b/lms/djangoapps/verify_student/toggles.py
@@ -13,10 +13,10 @@
 # .. toggle_default: False
 # .. toggle_description: Supports staged rollout to students for a new email templates
 #   implementation for ID verification.
-# .. toggle_use_cases: incremental_release, open_edx
+# .. toggle_use_cases: temporary, open_edx
 # .. toggle_creation_date: 2020-06-25
-# .. toggle_target_removal_date: n/a
-# .. toggle_warnings: n/a
+# .. toggle_target_removal_date: None
+# .. toggle_warnings: This temporary feature toggle does not have a target removal date.
 # .. toggle_tickets: PROD-1639
 USE_NEW_EMAIL_TEMPLATES = WaffleFlag(
     waffle_namespace=WAFFLE_FLAG_NAMESPACE,
@@ -34,10 +34,10 @@ def use_new_templates_for_id_verification_emails():
 # .. toggle_implementation: WaffleFlag
 # .. toggle_default: False
 # .. toggle_description: Supports staged rollout to students for the new IDV flow.
-# .. toggle_use_cases: incremental_release, open_edx
+# .. toggle_use_cases: temporary, open_edx
 # .. toggle_creation_date: 2020-07-09
-# .. toggle_target_removal_date: n/a
-# .. toggle_warnings: n/a
+# .. toggle_target_removal_date: None
+# .. toggle_warnings: This temporary feature toggle does not have a target removal date.
 # .. toggle_tickets: MST-318
 REDIRECT_TO_IDV_MICROFRONTEND = WaffleFlag(
     waffle_namespace=WAFFLE_FLAG_NAMESPACE,