From a4ba4ae45efbf1a60ead62222adc60a25c6bc45a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Mon, 14 Sep 2020 11:21:34 +0200 Subject: [PATCH] Clarify many feature toggle annotations across all applications --- cms/djangoapps/contentstore/config/waffle.py | 2 +- cms/envs/common.py | 18 +- doc.rst.j2 | 1 - lms/djangoapps/bulk_email/models.py | 4 - lms/djangoapps/course_api/__init__.py | 8 +- lms/djangoapps/course_api/blocks/toggles.py | 9 +- lms/djangoapps/courseware/toggles.py | 4 +- lms/djangoapps/discussion/config/settings.py | 3 - lms/djangoapps/experiments/utils.py | 6 +- lms/djangoapps/experiments/views_custom.py | 4 +- lms/djangoapps/verify_student/toggles.py | 12 +- lms/envs/common.py | 174 ++++++------------ .../djangoapps/user_api/accounts/toggles.py | 4 +- .../djangoapps/user_authn/config/waffle.py | 2 +- .../djangoapps/user_authn/views/register.py | 3 +- .../core/djangoapps/video_config/models.py | 12 +- .../video_pipeline/config/waffle.py | 17 +- .../core/djangoapps/video_pipeline/models.py | 9 - .../core/djangoapps/waffle_utils/__init__.py | 2 - .../features/course_duration_limits/models.py | 6 +- .../features/course_experience/__init__.py | 11 +- openedx/features/course_experience/waffle.py | 3 - openedx/features/discounts/applicability.py | 4 +- openedx/features/learner_profile/toggles.py | 2 +- 24 files changed, 105 insertions(+), 215 deletions(-) diff --git a/cms/djangoapps/contentstore/config/waffle.py b/cms/djangoapps/contentstore/config/waffle.py index a4bfc68cf4..4c07260b5f 100644 --- a/cms/djangoapps/contentstore/config/waffle.py +++ b/cms/djangoapps/contentstore/config/waffle.py @@ -50,7 +50,7 @@ SHOW_REVIEW_RULES_FLAG = CourseWaffleFlag( # .. 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 index 0db1490c5c..a9d45cadaa 100644 --- a/cms/envs/common.py +++ b/cms/envs/common.py @@ -341,9 +341,7 @@ FEATURES = { # 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 @@ FEATURES = { # .. 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 @@ FEATURES = { # .. 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 @@ FEATURES = { # .. 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 @@ FEATURES = { # 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 @@ FEATURES = { # .. 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 @@ EDXAPP_PARSE_KEYS = {} # .. 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 @@ DISABLE_DEPRECATED_SIGNIN_URL = False # .. 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 index 787e7d2c52..b4bd367509 100644 --- 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 index 9191dcd837..2e093ad8b0 100644 --- 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 index 84f273472b..514905f0b9 100644 --- a/lms/djangoapps/course_api/__init__.py +++ b/lms/djangoapps/course_api/__init__.py @@ -10,10 +10,8 @@ WAFFLE_SWITCH_NAMESPACE = WaffleSwitchNamespace(name='course_list_api_rate_limit # .. 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 @@ -21,9 +19,7 @@ USE_RATE_LIMIT_2_FOR_COURSE_LIST_API = WaffleSwitch(WAFFLE_SWITCH_NAMESPACE, 'ra # .. 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 index 09b8ea9934..628cabe3dc 100644 --- a/lms/djangoapps/course_api/blocks/toggles.py +++ b/lms/djangoapps/course_api/blocks/toggles.py @@ -3,7 +3,7 @@ Toggles for Course API. """ -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 @@ COURSE_BLOCKS_API_NAMESPACE = WaffleFlagNamespace(name=u'course_blocks_api') # .. 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 index 1e01c18538..a80eacaf00 100644 --- a/lms/djangoapps/courseware/toggles.py +++ b/lms/djangoapps/courseware/toggles.py @@ -13,7 +13,7 @@ WAFFLE_FLAG_NAMESPACE = WaffleFlagNamespace(name='courseware') # .. 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 @@ REDIRECT_TO_COURSEWARE_MICROFRONTEND = ExperimentWaffleFlag( # .. 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 index a31af3479f..946754cb1b 100644 --- a/lms/djangoapps/discussion/config/settings.py +++ b/lms/djangoapps/discussion/config/settings.py @@ -11,9 +11,6 @@ from django.conf import settings # 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 index 5528872294..3d954da94e 100644 --- a/lms/djangoapps/experiments/utils.py +++ b/lms/djangoapps/experiments/utils.py @@ -41,8 +41,8 @@ experiments_namespace = WaffleFlagNamespace(name=u'experiments') # .. 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 @@ PROGRAM_INFO_FLAG = WaffleFlag( # .. 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 @@ DASHBOARD_INFO_FLAG = WaffleFlag(experiments_namespace, u'add_dashboard_info', _ # .. 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 index 70a1fa56ad..95445816a4 100644 --- a/lms/djangoapps/experiments/views_custom.py +++ b/lms/djangoapps/experiments/views_custom.py @@ -35,13 +35,11 @@ from track import segment # .. 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 index 88dd5cf898..3df8a34854 100644 --- a/lms/djangoapps/verify_student/toggles.py +++ b/lms/djangoapps/verify_student/toggles.py @@ -13,10 +13,10 @@ WAFFLE_FLAG_NAMESPACE = WaffleFlagNamespace(name='verify_student') # .. 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, diff --git a/lms/envs/common.py b/lms/envs/common.py index dd6b0c9c2a..27c755246d 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -87,10 +87,8 @@ FEATURES = { # .. toggle_default: True # .. toggle_description: Add a "Staff Debug" button to course modules for debugging # by course staff. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-09-04 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/2425 'DISPLAY_DEBUG_INFO_TO_STAFF': True, 'DISPLAY_HISTOGRAMS_TO_STAFF': False, # For large courses this slows down courseware access for staff. @@ -102,9 +100,7 @@ FEATURES = { # .. toggle_default: False # .. toggle_description: When True, all courses will be active, regardless of start # date. - # .. toggle_use_cases: ? - # .. toggle_creation_date: ? - # .. toggle_target_removal_date: None + # .. toggle_use_cases: open_edx # .. toggle_warnings: This will cause ALL courses to be immediately visible. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/17913 ## DO NOT SET TO True IN THIS FILE @@ -119,10 +115,8 @@ FEATURES = { # .. toggle_implementation: DjangoSetting # .. toggle_default: True # .. toggle_description: Add PDF and HTML textbook tabs to the courseware. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-03-27 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/3064 'ENABLE_TEXTBOOK': True, @@ -138,27 +132,21 @@ FEATURES = { # registrations. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-08-19 - # .. toggle_target_removal_date: None - # .. toggle_warnings: It is not recommended to enable this feature if - # ENABLE_DISCUSSION_HOME_PANEL is not enabled, since subscribers who receive - # digests in that case will only be able to unsubscribe via links embedded in + # .. toggle_warnings: It is not recommended to enable this feature if ENABLE_DISCUSSION_HOME_PANEL is not enabled, + # since subscribers who receive digests in that case will only be able to unsubscribe via links embedded in # their emails, and they will have no way to resubscribe. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/4891 'ENABLE_DISCUSSION_EMAIL_DIGEST': False, - # toggle_name: ENABLE_UNICODE_USERNAME - # toggle_implementation: DjangoSetting - # toggle_default: False - # toggle_description: Set this to True to allow unicode characters in username. Enabling this will also + # .. toggle_name: ENABLE_UNICODE_USERNAME + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Set this to True to allow unicode characters in username. Enabling this will also # automatically enable SOCIAL_AUTH_CLEAN_USERNAMES. When this is enabled, usernames will have to match the # regular expression defined by USERNAME_REGEX_PARTIAL. - # toggle_category: admin - # toggle_use_cases: open_edx - # toggle_creation_date: 2017-06-27 - # toggle_target_removal_date: None - # toggle_warnings: None - # toggle_tickets: https://github.com/edx/edx-platform/pull/14729 - # toggle_status: supported + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2017-06-27 + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/14729 'ENABLE_UNICODE_USERNAME': False, 'ENABLE_DJANGO_ADMIN_SITE': True, # set true to enable django's admin site, even on prod (e.g. for course ops) @@ -167,26 +155,19 @@ FEATURES = { # .. toggle_name: ENABLE_MASQUERADE # .. toggle_implementation: DjangoSetting # .. toggle_default: True - # .. toggle_description: Allow course staff to change to student view of courseware by accessing the - # /course/{course_id}/masquerade url. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2013-04-13 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None - # .. toggle_tickets: None 'ENABLE_MASQUERADE': True, # .. toggle_name: ENABLE_SYSADMIN_DASHBOARD # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: enables dashboard at /syadmin/ for django staff, for seeing overview of system status, for - # deleting and loading courses, for seeing log of git imports of courseware. Note that some views are not - # performant when there are more than 100 courses. + # deleting and loading courses, for seeing log of git imports of courseware. Note that some views are noopen_edx # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2013-12-12 # .. toggle_target_removal_date: None - # .. toggle_warnings: This feature is not supported anymore. - # .. toggle_tickets: None + # .. toggle_warnings: This feature is not supported anymore and should have a target removal date. 'ENABLE_SYSADMIN_DASHBOARD': False, # sysadmin dashboard, to see what courses are loaded, to delete & load courses 'DISABLE_LOGIN_BUTTON': False, # used in systems where login is automatic, eg MIT SSL @@ -199,7 +180,7 @@ FEATURES = { # .. toggle_use_cases: temporary # .. toggle_creation_date: 2014-09-09 # .. toggle_target_removal_date: None - # .. toggle_warnings: None + # .. toggle_warnings: This temporary feature toggle does not have a target removal date. 'ENABLE_OAUTH2_PROVIDER': False, # .. toggle_name: ENABLE_XBLOCK_VIEW_ENDPOINT @@ -208,10 +189,8 @@ FEATURES = { # .. toggle_description: Enable an API endpoint, named "xblock_view", to serve rendered XBlock views. This might be # used by external applications. See for instance jquery-xblock (now unmaintained): # https://github.com/edx-solutions/jquery-xblock - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-03-14 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/2968 'ENABLE_XBLOCK_VIEW_ENDPOINT': False, @@ -267,9 +246,7 @@ FEATURES = { # allows verified certificates, like courses.edx.org. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2019-05-14 - # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/PROD-269 - # .. toggle_warnings: ??? 'DISABLE_HONOR_CERTIFICATES': False, # Toggle to disable honor certificates 'DISABLE_AUDIT_CERTIFICATES': False, # Toggle to disable audit certificates @@ -286,32 +263,25 @@ FEATURES = { # querystring parameters. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-05-07 - # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/TE-2545 'RESTRICT_AUTOMATIC_AUTH': True, - # toggle_name: ENABLE_LOGIN_MICROFRONTEND - # toggle_implementation: DjangoSetting - # toggle_default: False - # toggle_description: Enable the login micro frontend. - # toggle_category: admin - # toggle_use_cases: open_edx - # toggle_creation_date: 2018-05-07 - # toggle_target_removal_date: None - # toggle_warnings: The login MFE domain name should be listed in LOGIN_REDIRECT_WHITELIST. - # toggle_status: supported + # .. toggle_name: ENABLE_LOGIN_MICROFRONTEND + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Enable the login micro frontend. + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2018-05-07 + # .. toggle_warnings: The login MFE domain name should be listed in LOGIN_REDIRECT_WHITELIST. 'ENABLE_LOGIN_MICROFRONTEND': False, - # toggle_name: SKIP_EMAIL_VALIDATION - # toggle_implementation: DjangoSetting - # toggle_default: False - # toggle_description: Turn this on to skip sending emails for user validation. + # .. toggle_name: SKIP_EMAIL_VALIDATION + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Turn this on to skip sending emails for user validation. # Beware, as this leaves the door open to potential spam abuse. - # toggle_category: admin - # toggle_use_cases: open_edx - # toggle_target_removal_date: None - # toggle_warnings: The login MFE domain name should be listed in LOGIN_REDIRECT_WHITELIST. - # toggle_status: supported + # .. toggle_use_cases: open_edx + # .. toggle_warnings: The login MFE domain name should be listed in LOGIN_REDIRECT_WHITELIST. 'SKIP_EMAIL_VALIDATION': False, # Toggle the availability of the shopping cart page @@ -328,11 +298,10 @@ FEATURES = { # .. toggle_default: False # .. toggle_description: Enable the display of "cosmetic_display_price", set in a course advanced settings. This # cosmetic price is used when there is no registration price associated to the course. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-10-10 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/6876 + # .. toggle_warnings: The use case of this feature toggle is uncertain. 'ENABLE_COSMETIC_DISPLAY_PRICE': False, # Automatically approve student identity verification attempts @@ -363,30 +332,25 @@ FEATURES = { # defaults, so that we maintain current behavior 'ALLOW_WIKI_ROOT_ACCESS': True, - # toggle_name: ENABLE_THIRD_PARTY_AUTH - # toggle_implementation: DjangoSetting - # toggle_default: False - # toggle_description: Turn on third-party auth. Disabled for now because full mplementations are not yet available. - # Remember to run migrations if you enable this; we don't create tables by default. This feature can be enabled - # on a per-site basis. When enabling this feature, remember to define the allowed authentication backends with - # the AUTHENTICATION_BACKENDS setting. - # toggle_category: admin - # toggle_use_cases: open_edx - # toggle_creation_date: 2014-09-15 - # toggle_target_removal_date: None - # toggle_status: supported - # toggle_warnings: None + # .. toggle_name: ENABLE_THIRD_PARTY_AUTH + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Turn on third-party auth. Disabled for now because full mplementations are not yet + # available. Remember to run migrations if you enable this; we don't create tables by default. This feature can + # be enabled on a per-site basis. When enabling this feature, remember to define the allowed authentication + # backends with the AUTHENTICATION_BACKENDS setting. + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2014-09-15 'ENABLE_THIRD_PARTY_AUTH': False, # .. toggle_name: ENABLE_MKTG_SITE # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: Toggle to enable alternate urls for marketing links. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-03-24 - # .. toggle_target_removal_date: None - # .. toggle_warnings: When this is enabled, the MKTG_URLS setting should be defined. - # .. toggle_tickets: ? + # .. toggle_warnings: When this is enabled, the MKTG_URLS setting should be defined. The use case of this feature + # toggle is uncertain. 'ENABLE_MKTG_SITE': False, # Prevent concurrent logins per user @@ -403,10 +367,8 @@ FEATURES = { # .. toggle_description: When a user goes to the homepage ('/') the user sees the courses listed in the # announcement dates order - this is default Open edX behavior. Set to True to change the course sorting behavior # by their start dates, latest first. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-03-27 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/7548 'ENABLE_COURSE_SORTING_BY_START_DATE': True, @@ -416,10 +378,8 @@ FEATURES = { # .. toggle_description: When enabled, along with the ENABLE_MKTG_SITE feature toggle, users who attempt to access a # course "about" page will be redirected to the course home url. This url might be the course "info" page or the # unified course tab (when the UNIFIED_COURSE_TAB_FLAG waffle is enabled). - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2019-01-15 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/19604 'ENABLE_COURSE_HOME_REDIRECT': True, @@ -434,9 +394,7 @@ FEATURES = { # specific configuration. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2016-06-24 - # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/OSPR-1320 - # .. toggle_warnings: None 'ENABLE_COMBINED_LOGIN_REGISTRATION_FOOTER': False, # Enable organizational email opt-in @@ -482,10 +440,8 @@ FEATURES = { # .. toggle_default: False # .. toggle_description: Toggle platform-wide course licensing. The course.license attribute is then used to append # license information to the courseware. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-05-14 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/7315 'LICENSING': False, @@ -498,9 +454,8 @@ FEATURES = { # .. toggle_description: Add a course search widget to the LMS for searching courses. When this is enabled, the # latest courses are no longer displayed on the LMS landing page. Also, an "Explore Courses" item is added to the # navbar. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-04-23 - # .. toggle_target_removal_date: None # .. toggle_warnings: The COURSE_DISCOVERY_MEANINGS setting should be properly defined. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/7845 'ENABLE_COURSE_DISCOVERY': False, @@ -524,10 +479,8 @@ FEATURES = { # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: Enable to use special exams, aka timed and proctored exams. - # .. toggle_use_cases: ? + # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-09-04 - # .. toggle_target_removal_date: None - # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/9744 'ENABLE_SPECIAL_EXAMS': False, @@ -553,13 +506,10 @@ FEATURES = { # .. toggle_default: True # .. toggle_description: Write Courseware Student Module History (CSMH) to the extended table: this logs all # student activities to MySQL, in a separate database. - # .. toggle_use_cases: ? - # .. toggle_creation_date: ? - # .. toggle_target_removal_date: None + # .. toggle_use_cases: open_edx # .. toggle_warnings: Even though most Open edX instances run with a separate CSMH database, it may not always be # the case. When disabling this feature flag, remember to remove "coursewarehistoryextended" from the # INSTALLED_APPS and the "StudentModuleHistoryExtendedRouter" from the DATABASE_ROUTERS. - # .. toggle_tickets: None 'ENABLE_CSMH_EXTENDED': True, # Read from both the CSMH and CSMHE history tables. @@ -578,9 +528,7 @@ FEATURES = { # the signup page. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-04-12 - # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/YONK-513 - # .. toggle_warnings: None 'ALLOW_PUBLIC_ACCOUNT_CREATION': True, # Enable footer banner for cookie consent. @@ -618,9 +566,7 @@ FEATURES = { # with. This setting can be overridden by a site-specific configuration. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-07-20 - # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/OSPR-1832 - # .. toggle_warnings: None 'ENABLE_PASSWORD_RESET_FAILURE_EMAIL': False, # Sets the default browser support. For more information go to http://browser-update.org/customize.html @@ -640,9 +586,7 @@ FEATURES = { # 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, # .. toggle_name: ENABLE_COURSEWARE_MICROFRONTEND @@ -652,7 +596,6 @@ FEATURES = { # REDIRECT_TO_COURSEWARE_MICROFRONTEND for course rollout) # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-03-05 - # .. toggle_target_removal_date: None # .. toggle_tickets: 'https://github.com/edx/edx-platform/pull/23317' # .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and see REDIRECT_TO_COURSEWARE_MICROFRONTEND for # rollout. @@ -662,11 +605,12 @@ FEATURES = { # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: Supports staged rollout of a new micro-frontend-based implementation of the logistration. - # .. toggle_use_cases: incremental_release, open_edx + # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2020-09-08 # .. toggle_target_removal_date: None # .. toggle_tickets: 'https://github.com/edx/edx-platform/pull/24908' - # .. toggle_warnings: Also set settings.ACCOUNT_MICROFRONTEND_URL and set REDIRECT_TO_ACCOUNT_MICROFRONTEND for rollout. + # .. toggle_warnings: Also set settings.ACCOUNT_MICROFRONTEND_URL and set REDIRECT_TO_ACCOUNT_MICROFRONTEND for + # rollout. This temporary feature toggle does not have a target removal date. 'ENABLE_LOGISTRATION_MICROFRONTEND': False, ### ORA Feature Flags ### @@ -675,11 +619,11 @@ FEATURES = { # .. 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 @@ -692,7 +636,7 @@ FEATURES = { # .. 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 @@ -704,7 +648,7 @@ FEATURES = { # .. 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: ENABLE_ORA_USERNAMES_ON_DATA_EXPORT @@ -712,11 +656,11 @@ FEATURES = { # .. toggle_default: False # .. toggle_description: Set to True to add deanonymized usernames to ORA data # report. - # .. toggle_use_cases: incremental_release + # .. toggle_use_cases: temporary # .. toggle_creation_date: 2020-06-11 # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/TNL-7273 - # .. toggle_warnings: None + # .. toggle_warnings: This temporary feature toggle does not have a target removal date. 'ENABLE_ORA_USERNAMES_ON_DATA_EXPORT': False, } diff --git a/openedx/core/djangoapps/user_api/accounts/toggles.py b/openedx/core/djangoapps/user_api/accounts/toggles.py index 3a7a68cacc..5bb2f019b5 100644 --- a/openedx/core/djangoapps/user_api/accounts/toggles.py +++ b/openedx/core/djangoapps/user_api/accounts/toggles.py @@ -11,7 +11,7 @@ from openedx.core.djangoapps.waffle_utils import WaffleFlag # .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Supports staged rollout of a new micro-frontend-based implementation of the order history page. -# .. toggle_use_cases: incremental_release, open_edx +# .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2019-04-11 # .. toggle_target_removal_date: 2020-12-31 # .. toggle_warnings: Also set settings.ORDER_HISTORY_MICROFRONTEND_URL and site's @@ -31,7 +31,7 @@ def should_redirect_to_order_history_microfrontend(): # .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Supports staged rollout of a new micro-frontend-based implementation of the account page. -# .. toggle_use_cases: incremental_release, open_edx +# .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2019-04-30 # .. toggle_target_removal_date: 2020-12-31 # .. toggle_warnings: Also set settings.ACCOUNT_MICROFRONTEND_URL and site's ENABLE_ACCOUNT_MICROFRONTEND. diff --git a/openedx/core/djangoapps/user_authn/config/waffle.py b/openedx/core/djangoapps/user_authn/config/waffle.py index a0db91887d..933d3cf395 100644 --- a/openedx/core/djangoapps/user_authn/config/waffle.py +++ b/openedx/core/djangoapps/user_authn/config/waffle.py @@ -13,7 +13,7 @@ _WAFFLE_SWITCH_NAMESPACE = WaffleSwitchNamespace(name=_WAFFLE_NAMESPACE, log_pre # .. toggle_default: False # .. toggle_description: When enabled, users must be sign in using their allowed domain SSO account. This includes sign- # ins to the Django admin dashboard at "/admin". -# .. toggle_use_cases: incremental_release +# .. toggle_use_cases: temporary # .. toggle_creation_date: 2019-11-20 # .. toggle_target_removal_date: 2020-01-31 # .. toggle_warnings: Requires THIRD_PARTY_AUTH_ONLY_DOMAIN to also be set. diff --git a/openedx/core/djangoapps/user_authn/views/register.py b/openedx/core/djangoapps/user_authn/views/register.py index 964d9eb6a7..de1010fe55 100644 --- a/openedx/core/djangoapps/user_authn/views/register.py +++ b/openedx/core/djangoapps/user_authn/views/register.py @@ -103,8 +103,7 @@ REGISTER_USER = Signal(providing_args=["user", "registration"]) # .. toggle_use_cases: temporary # .. toggle_creation_date: 2020-04-30 # .. toggle_target_removal_date: 2020-06-01 -# .. toggle_warnings: None -# .. toggle_tickets: None +# .. toggle_warnings: This temporary feature toggle does not have a target removal date. REGISTRATION_FAILURE_LOGGING_FLAG = WaffleFlag( waffle_namespace=WaffleFlagNamespace(name=u'registration'), flag_name=u'enable_failure_logging', diff --git a/openedx/core/djangoapps/video_config/models.py b/openedx/core/djangoapps/video_config/models.py index 8e85477d26..a263097b95 100644 --- a/openedx/core/djangoapps/video_config/models.py +++ b/openedx/core/djangoapps/video_config/models.py @@ -27,13 +27,9 @@ class HLSPlaybackEnabledFlag(ConfigurationModel): .. toggle_name: HLSPlaybackEnabledFlag.enabled_for_all_courses .. toggle_implementation: ConfigurationModel .. toggle_default: False - .. toggle_description: Add the "hls" profile to all displayed videos on the - platform. - .. toggle_category: video_config + .. toggle_description: Add the "hls" profile to all displayed videos on the platform. .. toggle_use_cases: open_edx .. toggle_creation_date: 2017-04-19 - .. toggle_target_removal_date: None - .. toggle_warnings: None .. toggle_tickets: https://github.com/edx/edx-platform/pull/14924 """ # this field overrides course-specific settings @@ -81,13 +77,9 @@ class CourseHLSPlaybackEnabledFlag(ConfigurationModel): .. toggle_name: CourseHLSPlaybackEnabledFlag.course_id .. toggle_implementation: ConfigurationModel .. toggle_default: False - .. toggle_description: Add the "hls" profile to all displayed videos for a single - course. - .. toggle_category: video_config + .. toggle_description: Add the "hls" profile to all displayed videos for a single course. .. toggle_use_cases: open_edx .. toggle_creation_date: 2017-04-19 - .. toggle_target_removal_date: None - .. toggle_warnings: None .. toggle_tickets: https://github.com/edx/edx-platform/pull/14924 """ KEY_FIELDS = ('course_id',) diff --git a/openedx/core/djangoapps/video_pipeline/config/waffle.py b/openedx/core/djangoapps/video_pipeline/config/waffle.py index ced4ed4ae3..1cb9e88f9c 100644 --- a/openedx/core/djangoapps/video_pipeline/config/waffle.py +++ b/openedx/core/djangoapps/video_pipeline/config/waffle.py @@ -11,25 +11,22 @@ WAFFLE_NAMESPACE = 'videos' # .. toggle_name: videos.deprecate_youtube # .. toggle_implementation: WaffleFlag # .. toggle_default: False -# .. toggle_description: Waffle flag telling whether youtube is deprecated. When -# enabled, videos are no longer uploaded to YouTube as part of the video pipeline. +# .. toggle_description: Waffle flag telling whether youtube is deprecated. When enabled, videos are no longer uploaded +# to YouTube as part of the video pipeline. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-08-03 -# .. toggle_target_removal_date: None -# .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/18765 DEPRECATE_YOUTUBE = 'deprecate_youtube' # .. toggle_name: videos.enable_devstack_video_uploads # .. toggle_implementation: WaffleFlag # .. toggle_default: False -# .. toggle_description: When enabled, use Multi-Factor Authentication (MFA) for -# authenticating to AWS. These short-lived access tokens are well suited for -# development (probably?). +# .. toggle_description: When enabled, use Multi-Factor Authentication (MFA) for authenticating to AWS. These short- +# lived access tokens are well suited for development (probably?). [At the time of annotation, the exact consequences +# of enabling this feature toggle are uncertain.] # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-03-12 -# .. toggle_target_removal_date: None -# .. toggle_warnings: Enabling this feature requires that the ROLE_ARN, -# MFA_SERIAL_NUMBER, MFA_TOKEN settings are properly defined. +# .. toggle_warnings: Enabling this feature requires that the ROLE_ARN, MFA_SERIAL_NUMBER, MFA_TOKEN settings are +# properly defined. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/23375 ENABLE_DEVSTACK_VIDEO_UPLOADS = 'enable_devstack_video_uploads' ENABLE_VEM_PIPELINE = 'enable_vem_pipeline' diff --git a/openedx/core/djangoapps/video_pipeline/models.py b/openedx/core/djangoapps/video_pipeline/models.py index 095ff97ca1..1302510a05 100644 --- a/openedx/core/djangoapps/video_pipeline/models.py +++ b/openedx/core/djangoapps/video_pipeline/models.py @@ -56,11 +56,8 @@ class VEMPipelineIntegration(ConfigurationModel): .. toggle_default: False .. toggle_description: Send videos to the Video Encode Manager (VEM) as part of the video pipeline. - .. toggle_category: video_pipeline .. toggle_use_cases: open_edx .. toggle_creation_date: 2020-06-04 - .. toggle_target_removal_date: None - .. toggle_warnings: None .. toggle_tickets: https://github.com/edx/edx-platform/pull/24093 """ client_name = models.CharField( @@ -101,11 +98,8 @@ class VideoUploadsEnabledByDefault(ConfigurationModel): .. toggle_default: False .. toggle_description: Allow video uploads for all courses of the platform. This enables the "Video Uploads" menu in the CMS. - .. toggle_category: video_pipeline .. toggle_use_cases: open_edx .. toggle_creation_date: 2017-11-10 - .. toggle_target_removal_date: None - .. toggle_warnings: None .. toggle_tickets: https://github.com/edx/edx-platform/pull/16536 """ # this field overrides course-specific settings @@ -155,11 +149,8 @@ class CourseVideoUploadsEnabledByDefault(ConfigurationModel): .. toggle_default: False .. toggle_description: Allow video uploads for a specific course. This enables the "Video Uploads" menu in the CMS. - .. toggle_category: video_pipeline .. toggle_use_cases: open_edx .. toggle_creation_date: 2017-11-10 - .. toggle_target_removal_date: None - .. toggle_warnings: None .. toggle_tickets: https://github.com/edx/edx-platform/pull/16536 """ KEY_FIELDS = ('course_id',) diff --git a/openedx/core/djangoapps/waffle_utils/__init__.py b/openedx/core/djangoapps/waffle_utils/__init__.py index b8f0cadcd5..20cf06480f 100644 --- a/openedx/core/djangoapps/waffle_utils/__init__.py +++ b/openedx/core/djangoapps/waffle_utils/__init__.py @@ -385,8 +385,6 @@ def _get_waffle_flag_custom_metrics_set(): # values of (True, False, or Both). # .. toggle_use_cases: opt_in # .. toggle_creation_date: 2020-06-17 -# .. toggle_target_removal_date: None -# .. toggle_tickets: None # .. toggle_warnings: Intent is for temporary research (1 day - several weeks) of a flag's usage. _WAFFLE_FLAG_CUSTOM_METRICS = 'WAFFLE_FLAG_CUSTOM_METRICS' diff --git a/openedx/features/course_duration_limits/models.py b/openedx/features/course_duration_limits/models.py index 448601e39e..70a46031d6 100644 --- a/openedx/features/course_duration_limits/models.py +++ b/openedx/features/course_duration_limits/models.py @@ -25,12 +25,8 @@ class CourseDurationLimitConfig(StackedConfigurationModel): .. toggle_description: When enabled, users will have a limited time to complete and audit the course. The exact duration is given by the "weeks_to_complete" course detail. When enabled, it is necessary to also define the "enabled_as_of" flag: only enrollments created after this date will be affected. - .. toggle_category: ? - .. toggle_use_cases: ? + .. toggle_use_cases: opt_in .. toggle_creation_date: 2018-11-02 - .. toggle_target_removal_date: None - .. toggle_warnings: None - .. toggle_tickets: None """ STACKABLE_FIELDS = ('enabled', 'enabled_as_of') diff --git a/openedx/features/course_experience/__init__.py b/openedx/features/course_experience/__init__.py index b371f81814..bc9e7cec64 100644 --- a/openedx/features/course_experience/__init__.py +++ b/openedx/features/course_experience/__init__.py @@ -92,9 +92,9 @@ COURSE_PRE_START_ACCESS_FLAG = WaffleFlag(WAFFLE_FLAG_NAMESPACE, 'pre_start_acce # .. toggle_description: Used with our integration with CourseTalk to display reviews for a course. # .. toggle_use_cases: temporary # .. toggle_creation_date: 2017-06-19 -# .. toggle_target_removal_date: ??? +# .. toggle_target_removal_date: None # .. toggle_warnings: We are no longer integrating with CourseTalk, so this probably should be deprecated and the code -# for reviews should be removed. +# for reviews should be removed. This temporary feature toggle should have a target removal date. # .. toggle_tickets: DEPR-48 SHOW_REVIEWS_TOOL_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'show_reviews_tool', __name__) @@ -105,9 +105,8 @@ SHOW_REVIEWS_TOOL_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'show_reviews_t # .. toggle_description: Used to determine whether or not to use course goals for the particular course. # .. toggle_use_cases: opt_out, temporary # .. toggle_creation_date: 2017-09-11 -# .. toggle_target_removal_date: ??? -# .. toggle_warnings: N/A -# .. toggle_tickets: N/A +# .. toggle_target_removal_date: None +# .. toggle_warnings: This temporary feature toggle does not have a target removal date. ENABLE_COURSE_GOALS = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'enable_course_goals', __name__) # Waffle flag to control the display of the hero @@ -123,10 +122,8 @@ UPGRADE_DEADLINE_MESSAGE = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'upgrade_dead # .. toggle_description: Used to switch between 'welcome message' and 'latest update' on the course home page. # .. toggle_use_cases: opt_out # .. toggle_creation_date: 2017-09-11 -# .. toggle_target_removal_date: ??? # .. toggle_warnings: This is meant to be configured using waffle_utils course override only. Either do not create the # actual waffle flag, or be sure to unset the flag even for Superusers. -# .. toggle_tickets: N/A LATEST_UPDATE_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'latest_update', __name__) # Waffle flag to enable anonymous access to a course diff --git a/openedx/features/course_experience/waffle.py b/openedx/features/course_experience/waffle.py index b61f0ec717..a00dab3a9a 100644 --- a/openedx/features/course_experience/waffle.py +++ b/openedx/features/course_experience/waffle.py @@ -15,9 +15,6 @@ WAFFLE_NAMESPACE = u'course_experience' # .. toggle_description: Used to determine whether to show custom HTML in the sidebar on the internal course about page. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-01-26 -# .. toggle_target_removal_date: ??? -# .. toggle_warnings: N/A -# .. toggle_tickets: N/A ENABLE_COURSE_ABOUT_SIDEBAR_HTML = u'enable_about_sidebar_html' diff --git a/openedx/features/discounts/applicability.py b/openedx/features/discounts/applicability.py index c0fc46775e..42f12d0d18 100644 --- a/openedx/features/discounts/applicability.py +++ b/openedx/features/discounts/applicability.py @@ -30,13 +30,11 @@ from track import segment # .. toggle_type: flag # .. toggle_default: False # .. toggle_description: Toggle discounts always being disabled -# .. toggle_category: discounts # .. toggle_use_cases: temporary # .. toggle_creation_date: 2019-4-16 # .. toggle_target_removal_date: None -# .. toggle_warnings: None # .. toggle_tickets: REVEM-282 -# .. toggle_status: supported +# .. toggle_warnings: This temporary feature toggle does not have a target removal date. DISCOUNT_APPLICABILITY_FLAG = WaffleFlag( waffle_namespace=WaffleFlagNamespace(name=u'discounts'), flag_name=u'enable_discounting', diff --git a/openedx/features/learner_profile/toggles.py b/openedx/features/learner_profile/toggles.py index b211dcba24..208bcb45fc 100644 --- a/openedx/features/learner_profile/toggles.py +++ b/openedx/features/learner_profile/toggles.py @@ -15,7 +15,7 @@ WAFFLE_FLAG_NAMESPACE = WaffleFlagNamespace(name='learner_profile') # .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Supports staged rollout of a new micro-frontend-based implementation of the profile page. -# .. toggle_use_cases: incremental_release, open_edx +# .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2019-02-19 # .. toggle_target_removal_date: 2020-12-31 # .. toggle_warnings: Also set settings.PROFILE_MICROFRONTEND_URL and site's ENABLE_PROFILE_MICROFRONTEND.