diff --git a/cms/envs/common.py b/cms/envs/common.py index ea9172e20f..0539804ce1 100644 --- a/cms/envs/common.py +++ b/cms/envs/common.py @@ -349,6 +349,8 @@ 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_warnings: None # .. toggle_tickets: 'https://github.com/edx/edx-platform/pull/21616' 'ENABLE_CHANGE_USER_PASSWORD_ADMIN': False, diff --git a/common/djangoapps/util/milestones_helpers.py b/common/djangoapps/util/milestones_helpers.py index df56591de8..de32ab1964 100644 --- a/common/djangoapps/util/milestones_helpers.py +++ b/common/djangoapps/util/milestones_helpers.py @@ -25,6 +25,7 @@ NAMESPACE_CHOICES = { REQUEST_CACHE_NAME = "milestones" +# TODO this should be moved to edx/edx-milestones # .. toggle_name: FEATURES['ENABLE_MILESTONES_APP'] # .. toggle_implementation: SettingDictToggle # .. toggle_default: False @@ -32,7 +33,9 @@ REQUEST_CACHE_NAME = "milestones" # the Open edX platform. (see https://github.com/edx/edx-milestones) # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-11-21 -# TODO this should be moved to edx/edx-milestones +# .. toggle_target_removal_date: None +# .. toggle_warnings: None +# .. toggle_tickets: None ENABLE_MILESTONES_APP = SettingDictToggle("FEATURES", "MILESTONES_APP", default=False, module_name=__name__) diff --git a/lms/djangoapps/bulk_email/models.py b/lms/djangoapps/bulk_email/models.py index 2e093ad8b0..9e15719569 100644 --- a/lms/djangoapps/bulk_email/models.py +++ b/lms/djangoapps/bulk_email/models.py @@ -487,6 +487,9 @@ class BulkEmailFlag(ConfigurationModel): is not available. .. 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 c520da14b0..80a600e7d3 100644 --- a/lms/djangoapps/course_api/__init__.py +++ b/lms/djangoapps/course_api/__init__.py @@ -12,6 +12,8 @@ WAFFLE_SWITCH_NAMESPACE = WaffleSwitchNamespace(name='course_list_api_rate_limit # users, this limit is 10 requests/minute. # .. 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,5 +23,7 @@ USE_RATE_LIMIT_2_FOR_COURSE_LIST_API = WaffleSwitch(WAFFLE_SWITCH_NAMESPACE, 'ra # users, this limit is 20 requests/minute. # .. 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 dc4312363d..16a5e82108 100644 --- a/lms/djangoapps/course_api/blocks/toggles.py +++ b/lms/djangoapps/course_api/blocks/toggles.py @@ -12,7 +12,10 @@ COURSE_BLOCKS_API_NAMESPACE = WaffleFlagNamespace(name=u'course_blocks_api') # .. toggle_default: False # .. toggle_description: Waffle flag to hide access denial messages in the course blocks. # .. toggle_use_cases: temporary, open_edx +# .. toggle_creation_date: 2019-09-27 +# .. toggle_target_removal_date: None # .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_tickets: None 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 36d354bf61..febbf424f3 100644 --- a/lms/djangoapps/courseware/toggles.py +++ b/lms/djangoapps/courseware/toggles.py @@ -47,9 +47,9 @@ COURSEWARE_MICROFRONTEND_COURSE_TEAM_PREVIEW = CourseWaffleFlag( # .. toggle_default: False # .. toggle_description: Supports staged rollout of the new micro-frontend-based implementation of the course exit page. # .. toggle_category: micro-frontend -# .. toggle_use_cases: incremental_release, open_edx +# .. toggle_use_cases: open_edx, temporary # .. toggle_creation_date: 2020-10-02 -# .. toggle_target_removal_date: n/a +# .. toggle_target_removal_date: None # .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and ENABLE_COURSEWARE_MICROFRONTEND. # .. toggle_tickets: AA-188 COURSEWARE_MICROFRONTEND_COURSE_EXIT_PAGE = CourseWaffleFlag( @@ -78,7 +78,7 @@ COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES = CourseWaffleFlag( # courseware page. # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2020-10-07 -# .. toggle_target_removal_date: none +# .. toggle_target_removal_date: None # .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and ENABLE_COURSEWARE_MICROFRONTEND and # COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES. # .. toggle_tickets: AA-371 @@ -92,8 +92,10 @@ COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES_FIRST_SECTION_CELEBRATION = CourseW # .. toggle_description: Waffle flag to toggle various enhancements to the proctoring experience, including but # not limited to the display of learner facing proctoring information on the course outline, changes to the Proctortrack # onboarding flow, changes to IDV (identity verification) requirements, etc. -# .. toggle_use_cases: beta_testing +# .. toggle_use_cases: temporary # .. toggle_creation_date: 2020-10-07 +# .. toggle_target_removal_date: None +# .. toggle_warnings: None # .. toggle_tickets: MST-432 COURSEWARE_PROCTORING_IMPROVEMENTS = CourseWaffleFlag( WAFFLE_FLAG_NAMESPACE, 'proctoring_improvements', __name__ diff --git a/lms/djangoapps/discussion/config/settings.py b/lms/djangoapps/discussion/config/settings.py index 946754cb1b..db457e51b8 100644 --- a/lms/djangoapps/discussion/config/settings.py +++ b/lms/djangoapps/discussion/config/settings.py @@ -11,6 +11,9 @@ 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_warnings: None +# .. toggle_tickets: None ENABLE_FORUM_DAILY_DIGEST = 'enable_forum_daily_digest' diff --git a/lms/djangoapps/experiments/views_custom.py b/lms/djangoapps/experiments/views_custom.py index df920d5359..50c9a104eb 100644 --- a/lms/djangoapps/experiments/views_custom.py +++ b/lms/djangoapps/experiments/views_custom.py @@ -29,7 +29,7 @@ from student.models import CourseEnrollment from track import segment # .. toggle_name: experiments.mobile_upsell_rev934 -# .. toggle_type: flag +# .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Toggle mobile upsell enabled # .. toggle_use_cases: temporary diff --git a/lms/djangoapps/grades/config/models.py b/lms/djangoapps/grades/config/models.py index ea60c08540..c411341808 100644 --- a/lms/djangoapps/grades/config/models.py +++ b/lms/djangoapps/grades/config/models.py @@ -35,6 +35,8 @@ class PersistentGradesEnabledFlag(ConfigurationModel): feature for all courses. .. toggle_use_cases: temporary .. toggle_creation_date: 2016-08-26 + .. toggle_target_removal_date: None + .. toggle_warnings: None .. toggle_tickets: https://github.com/edx/edx-platform/pull/13329 """ # this field overrides course-specific settings to enable the feature for all courses diff --git a/lms/djangoapps/grades/config/waffle.py b/lms/djangoapps/grades/config/waffle.py index f57db2f87e..424244ee35 100644 --- a/lms/djangoapps/grades/config/waffle.py +++ b/lms/djangoapps/grades/config/waffle.py @@ -20,6 +20,7 @@ WAFFLE_NAMESPACE = u'grades' # for all courses. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-04-11 +# .. toggle_target_removal_date: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/14771 # .. toggle_warnings: This requires the PersistentGradesEnabledFlag to be enabled. ASSUME_ZERO_GRADE_IF_ABSENT = u'assume_zero_grade_if_absent' @@ -29,6 +30,8 @@ ASSUME_ZERO_GRADE_IF_ABSENT = u'assume_zero_grade_if_absent' # .. toggle_description: When enabled, a change in grading policy will not trigger re-grading. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-08-03 +# .. toggle_target_removal_date: None +# .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/15733 DISABLE_REGRADE_ON_POLICY_CHANGE = u'disable_regrade_on_policy_change' @@ -41,6 +44,8 @@ DISABLE_REGRADE_ON_POLICY_CHANGE = u'disable_regrade_on_policy_change' # in edx-platform, but only in edx-proctoring. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2019-05-29 +# .. toggle_target_removal_date: None +# .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/20719 REJECTED_EXAM_OVERRIDES_GRADE = u'rejected_exam_overrides_grade' # .. toggle_name: grades.rejected_exam_overrides_grade @@ -50,6 +55,8 @@ REJECTED_EXAM_OVERRIDES_GRADE = u'rejected_exam_overrides_grade' # is only valid for courses which actually have an end date. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-10-01 +# .. toggle_target_removal_date: None +# .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/19026 ENFORCE_FREEZE_GRADE_AFTER_COURSE_END = u'enforce_freeze_grade_after_course_end' @@ -60,6 +67,7 @@ ENFORCE_FREEZE_GRADE_AFTER_COURSE_END = u'enforce_freeze_grade_after_course_end' # the writable gradebook is added to the instructor dashboard. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-10-03 +# .. toggle_target_removal_date: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/19054 # .. toggle_warnings: Enabling this requires that the `WRITABLE_GRADEBOOK_URL` setting be properly defined. WRITABLE_GRADEBOOK = u'writable_gradebook' @@ -71,6 +79,8 @@ WRITABLE_GRADEBOOK = u'writable_gradebook' # as we understand, this feature is now unused and obsolete. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2019-08-20 +# .. toggle_target_removal_date: None +# .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/21389 BULK_MANAGEMENT = u'bulk_management' diff --git a/lms/djangoapps/instructor/toggles.py b/lms/djangoapps/instructor/toggles.py index 4b71e980ed..b6270618e9 100644 --- a/lms/djangoapps/instructor/toggles.py +++ b/lms/djangoapps/instructor/toggles.py @@ -14,13 +14,11 @@ WAFFLE_FLAG_NAMESPACE = WaffleFlagNamespace(name=WAFFLE_NAMESPACE) # .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: instructor -# .. toggle_category: Instructor dashboard -# .. toggle_use_cases: incremental_release, open_edx +# .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-07-8 -# .. toggle_expiration_date: ?? +# .. toggle_target_removal_date: None # .. toggle_warnings: ?? # .. toggle_tickets: PROD-1309 -# .. toggle_status: supported DATA_DOWNLOAD_V2 = CourseWaffleFlag( waffle_namespace=WaffleFlagNamespace(name=WAFFLE_NAMESPACE, log_prefix='instructor_dashboard: '), flag_name='enable_data_download_v2', @@ -32,9 +30,9 @@ DATA_DOWNLOAD_V2 = CourseWaffleFlag( # .. toggle_default: False # .. toggle_description: Supports staged rollout to improved is_small_course method. # .. toggle_category: instructor -# .. toggle_use_cases: incremental_release, open_edx +# .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-07-02 -# .. toggle_expiration_date: n/a +# .. toggle_target_removal_date: None # .. toggle_warnings: n/a # .. toggle_tickets: PROD-1740 # .. toggle_status: supported diff --git a/lms/envs/common.py b/lms/envs/common.py index 397c886b68..186a98d759 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -90,6 +90,8 @@ FEATURES = { # by course staff. # .. 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,6 +104,8 @@ FEATURES = { # .. toggle_description: When True, all courses will be active, regardless of start # date. # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2012-07-24 + # .. toggle_target_removal_date: None # .. 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 @@ -118,6 +122,8 @@ FEATURES = { # .. toggle_description: Add PDF and HTML textbook tabs to the courseware. # .. 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, @@ -133,6 +139,7 @@ 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 # their emails, and they will have no way to resubscribe. @@ -147,6 +154,8 @@ FEATURES = { # regular expression defined by USERNAME_REGEX_PARTIAL. # .. 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 'ENABLE_UNICODE_USERNAME': False, @@ -156,8 +165,12 @@ FEATURES = { # .. toggle_name: ENABLE_MASQUERADE # .. toggle_implementation: DjangoSetting # .. toggle_default: True + # .. toggle_description: None # .. 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 @@ -169,6 +182,7 @@ FEATURES = { # .. toggle_creation_date: 2013-12-12 # .. toggle_target_removal_date: None # .. toggle_warnings: This feature is not supported anymore and should have a target removal date. + # .. toggle_tickets: None '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 @@ -182,6 +196,7 @@ FEATURES = { # .. toggle_creation_date: 2014-09-09 # .. toggle_target_removal_date: None # .. toggle_warnings: This temporary feature toggle does not have a target removal date. + # .. toggle_tickets: None 'ENABLE_OAUTH2_PROVIDER': False, # .. toggle_name: ENABLE_XBLOCK_VIEW_ENDPOINT @@ -192,6 +207,8 @@ FEATURES = { # https://github.com/edx-solutions/jquery-xblock # .. 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, @@ -247,6 +264,8 @@ 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_warnings: None # .. toggle_tickets: https://openedx.atlassian.net/browse/PROD-269 'DISABLE_HONOR_CERTIFICATES': False, # Toggle to disable honor certificates @@ -264,6 +283,8 @@ FEATURES = { # querystring parameters. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-05-07 + # .. toggle_target_removal_date: None + # .. toggle_warnings: None # .. toggle_tickets: https://openedx.atlassian.net/browse/TE-2545 'RESTRICT_AUTOMATIC_AUTH': True, @@ -273,7 +294,9 @@ FEATURES = { # .. toggle_description: Enable the login micro frontend. # .. 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_tickets: None 'ENABLE_LOGIN_MICROFRONTEND': False, # .. toggle_name: SKIP_EMAIL_VALIDATION @@ -282,7 +305,10 @@ FEATURES = { # .. toggle_description: Turn this on to skip sending emails for user validation. # Beware, as this leaves the door open to potential spam abuse. # .. 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_tickets: None 'SKIP_EMAIL_VALIDATION': False, # .. toggle_name: ENABLE_COSMETIC_DISPLAY_PRICE @@ -292,6 +318,7 @@ FEATURES = { # cosmetic price is used when there is no registration price associated to the course. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-10-10 + # .. toggle_target_removal_date: 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, @@ -333,6 +360,9 @@ FEATURES = { # backends with the AUTHENTICATION_BACKENDS setting. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-09-15 + # .. toggle_target_removal_date: None + # .. toggle_warnings: None + # .. toggle_tickets: None 'ENABLE_THIRD_PARTY_AUTH': False, # .. toggle_name: ENABLE_MKTG_SITE @@ -341,8 +371,10 @@ FEATURES = { # .. toggle_description: Toggle to enable alternate urls for marketing links. # .. 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. The use case of this feature # toggle is uncertain. + # .. toggle_tickets: None 'ENABLE_MKTG_SITE': False, # Prevent concurrent logins per user @@ -361,6 +393,8 @@ FEATURES = { # by their start dates, latest first. # .. 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, @@ -372,6 +406,8 @@ FEATURES = { # unified course tab (when the DISABLE_UNIFIED_COURSE_TAB_FLAG waffle is not enabled). # .. 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, @@ -386,6 +422,8 @@ FEATURES = { # specific configuration. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2016-06-24 + # .. toggle_target_removal_date: None + # .. toggle_warnings: None # .. toggle_tickets: https://openedx.atlassian.net/browse/OSPR-1320 'ENABLE_COMBINED_LOGIN_REGISTRATION_FOOTER': False, @@ -434,6 +472,8 @@ FEATURES = { # license information to the courseware. # .. 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, @@ -448,6 +488,7 @@ FEATURES = { # navbar. # .. 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, @@ -473,6 +514,8 @@ FEATURES = { # .. toggle_description: Enable to use special exams, aka timed and proctored exams. # .. 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, @@ -499,9 +542,12 @@ FEATURES = { # .. 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: open_edx + # .. toggle_creation_date: 2020-11-05 + # .. toggle_target_removal_date: None # .. 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 "lms.djangoapps.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. @@ -520,6 +566,8 @@ FEATURES = { # the signup page. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-04-12 + # .. toggle_target_removal_date: None + # .. toggle_warnings: None # .. toggle_tickets: https://openedx.atlassian.net/browse/YONK-513 'ALLOW_PUBLIC_ACCOUNT_CREATION': True, @@ -558,6 +606,8 @@ 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_warnings: None # .. toggle_tickets: https://openedx.atlassian.net/browse/OSPR-1832 'ENABLE_PASSWORD_RESET_FAILURE_EMAIL': False, @@ -578,6 +628,8 @@ 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_warnings: None # .. toggle_tickets: 'https://github.com/edx/edx-platform/pull/21616' 'ENABLE_CHANGE_USER_PASSWORD_ADMIN': False, @@ -588,6 +640,7 @@ 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. @@ -2902,6 +2955,8 @@ ENABLE_CREDIT_ELIGIBILITY = True # Eligibility" section then appears for those courses in the LMS. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-06-17 +# .. toggle_target_removal_date: None +# .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/8550 FEATURES['ENABLE_CREDIT_ELIGIBILITY'] = ENABLE_CREDIT_ELIGIBILITY diff --git a/openedx/core/djangoapps/user_authn/views/register.py b/openedx/core/djangoapps/user_authn/views/register.py index bd86573087..18674b186d 100644 --- a/openedx/core/djangoapps/user_authn/views/register.py +++ b/openedx/core/djangoapps/user_authn/views/register.py @@ -96,13 +96,14 @@ REGISTER_USER = Signal(providing_args=["user", "registration"]) # .. toggle_name: registration.enable_failure_logging -# .. toggle_type: flag +# .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Enable verbose logging of registration failure messages # .. toggle_use_cases: temporary # .. toggle_creation_date: 2020-04-30 # .. toggle_target_removal_date: 2020-06-01 # .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_tickets: None 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 a263097b95..ca427f7c70 100644 --- a/openedx/core/djangoapps/video_config/models.py +++ b/openedx/core/djangoapps/video_config/models.py @@ -30,6 +30,8 @@ class HLSPlaybackEnabledFlag(ConfigurationModel): .. 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 @@ -80,6 +82,8 @@ class CourseHLSPlaybackEnabledFlag(ConfigurationModel): .. 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 f52eca95b4..2b87ef7d40 100644 --- a/openedx/core/djangoapps/video_pipeline/config/waffle.py +++ b/openedx/core/djangoapps/video_pipeline/config/waffle.py @@ -16,6 +16,8 @@ WAFFLE_NAMESPACE = 'videos' # 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 @@ -26,6 +28,7 @@ DEPRECATE_YOUTUBE = 'deprecate_youtube' # 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_tickets: https://github.com/edx/edx-platform/pull/23375 diff --git a/openedx/core/djangoapps/video_pipeline/models.py b/openedx/core/djangoapps/video_pipeline/models.py index a8e75f813a..dbf4f06df7 100644 --- a/openedx/core/djangoapps/video_pipeline/models.py +++ b/openedx/core/djangoapps/video_pipeline/models.py @@ -24,6 +24,8 @@ class VEMPipelineIntegration(ConfigurationModel): 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( @@ -66,6 +68,8 @@ class VideoUploadsEnabledByDefault(ConfigurationModel): enables the "Video Uploads" menu in the CMS. .. 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 @@ -117,6 +121,8 @@ class CourseVideoUploadsEnabledByDefault(ConfigurationModel): "Video Uploads" menu in the CMS. .. 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/toggles.py b/openedx/core/toggles.py index b3ef6e507e..c47d25e9dc 100644 --- a/openedx/core/toggles.py +++ b/openedx/core/toggles.py @@ -11,6 +11,8 @@ from edx_toggles.toggles import SettingDictToggle # of the course. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-12-01 +# .. toggle_target_removal_date: None +# .. toggle_warnings: None # .. toggle_tickets: https://openedx.atlassian.net/browse/SOL-40 ENTRANCE_EXAMS = SettingDictToggle( "FEATURES", "ENTRANCE_EXAMS", default=False, module_name=__name__ diff --git a/openedx/features/course_duration_limits/models.py b/openedx/features/course_duration_limits/models.py index 70a46031d6..13a57745f3 100644 --- a/openedx/features/course_duration_limits/models.py +++ b/openedx/features/course_duration_limits/models.py @@ -27,6 +27,9 @@ class CourseDurationLimitConfig(StackedConfigurationModel): "enabled_as_of" flag: only enrollments created after this date will be affected. .. 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 fe1ca1dd9f..bc8eb3140c 100644 --- a/openedx/features/course_experience/__init__.py +++ b/openedx/features/course_experience/__init__.py @@ -54,6 +54,7 @@ SHOW_REVIEWS_TOOL_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'show_reviews_t # .. toggle_creation_date: 2017-09-11 # .. toggle_target_removal_date: None # .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_tickets: None ENABLE_COURSE_GOALS = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'enable_course_goals', __name__) # Waffle flag to control the display of the hero @@ -69,8 +70,10 @@ 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: None # .. 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: None 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 3df104005f..0f6be7aa8d 100644 --- a/openedx/features/course_experience/waffle.py +++ b/openedx/features/course_experience/waffle.py @@ -15,6 +15,9 @@ 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: None +# .. toggle_warnings: None +# .. toggle_tickets: None 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 f84d3bfb1b..9ca8331779 100644 --- a/openedx/features/discounts/applicability.py +++ b/openedx/features/discounts/applicability.py @@ -27,7 +27,7 @@ from student.models import CourseEnrollment from track import segment # .. toggle_name: discounts.enable_discounting -# .. toggle_type: flag +# .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Toggle discounts always being disabled # .. toggle_use_cases: temporary