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

Wrap toggle annotation lines with multiline comments

Browse Source 
This takes advantage of the new multiline annotation format with
single-line comment prefix, from code-annotations.
This commit is contained in:
Régis Behmo
2020-08-27 16:36:12 +02:00
parent d34aa1c643
commit 7dc460d50a
13 changed files with 181 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
cms/envs/common.py
View File

@@ -337,7 +337,8 @@ FEATURES = {
# .. toggle_name: ENABLE_CHANGE_USER_PASSWORD_ADMIN
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: Set to True to enable changing a user password through django admin. This is disabled by default because enabling allows a method to bypass password policy.
# .. toggle_description: Set to True to enable changing a user password through django admin. This is disabled by
# default because enabling allows a method to bypass password policy.
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2020-02-21
@@ -366,8 +367,8 @@ FEATURES = {
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: A "work-around" feature toggle meant to help in cases where some file uploads are not
# discoverable. If enabled, will iterate through all possible file key suffixes up to the max for displaying
# file metadata in staff assessments.
# discoverable. If enabled, will iterate through all possible file key suffixes up to the max for displaying file
# metadata in staff assessments.
# .. toggle_category: ora
# .. toggle_use_cases: graceful_degradation
# .. toggle_creation_date: 2020-03-03
@@ -381,7 +382,7 @@ FEATURES = {
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: A "work-around" feature toggle meant to help in cases where some file uploads are not
# discoverable. If enabled, will pull file metadata from StudentModule.state for display in staff assessments.
# discoverable. If enabled, will pull file metadata from StudentModule.state for display in staff assessments.
# .. toggle_category: ora
# .. toggle_use_cases: graceful_degradation
# .. toggle_creation_date: 2020-03-03
@@ -403,7 +404,8 @@ FEATURES = {
# .. toggle_use_cases: incremental_release
# .. toggle_creation_date: 2020-06-12
# .. toggle_expiration_date: 2020-12-01
# .. toggle_warnings: This can be removed once support is removed for deprecated course keys.
# .. toggle_warnings: This can be removed once support is removed for deprecated
# course keys.
# .. toggle_tickets: https://openedx.atlassian.net/browse/DEPR-58
# .. toggle_status: supported
'DEPRECATE_OLD_COURSE_KEYS_IN_STUDIO': True,
@@ -418,7 +420,8 @@ FEATURES = {
# .. toggle_expiration_date: 2020-12-31
# .. toggle_tickets: https://openedx.atlassian.net/wiki/spaces/COMM/pages/1545011241/BD-14+Blockstore+Powered+Content+Libraries+Taxonomies
# .. toggle_status: supported
# .. toggle_warnings: Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and see REDIRECT_TO_LIBRARY_AUTHORING_MICROFRONTEND for rollout.
# .. toggle_warnings: Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and see
# REDIRECT_TO_LIBRARY_AUTHORING_MICROFRONTEND for rollout.
'ENABLE_LIBRARY_AUTHORING_MICROFRONTEND': False,
}

52
lms/djangoapps/course_api/__init__.py
View File

@@ -5,33 +5,29 @@ from openedx.core.djangoapps.waffle_utils import WaffleSwitch, WaffleSwitchNames
WAFFLE_SWITCH_NAMESPACE = WaffleSwitchNamespace(name='course_list_api_rate_limit')
"""
.. toggle_name: course_list_api_rate_limit.rate_limit_2
.. toggle_implementation: WaffleSwitch
.. 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_category: course_api
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2018-06-12
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: https://openedx.atlassian.net/browse/LEARNER-5527
.. toggle_status: supported
"""
# .. toggle_name: course_list_api_rate_limit.rate_limit_2
# .. toggle_implementation: WaffleSwitch
# .. 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_category: course_api
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2018-06-12
# .. toggle_expiration_date: None
# .. toggle_warnings: None
# .. toggle_tickets: https://openedx.atlassian.net/browse/LEARNER-5527
# .. toggle_status: supported
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_category: course_api
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2018-06-12
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: https://openedx.atlassian.net/browse/LEARNER-5527
.. toggle_status: supported
"""
# .. 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_category: course_api
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2018-06-12
# .. toggle_expiration_date: None
# .. toggle_warnings: None
# .. toggle_tickets: https://openedx.atlassian.net/browse/LEARNER-5527
# .. toggle_status: supported
USE_RATE_LIMIT_10_FOR_COURSE_LIST_API = WaffleSwitch(WAFFLE_SWITCH_NAMESPACE, 'rate_limit_10', __name__)

24
lms/djangoapps/course_api/blocks/toggles.py
View File

@@ -8,19 +8,17 @@ from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag, WaffleFlag, W
COURSE_BLOCKS_API_NAMESPACE = WaffleFlagNamespace(name=u'course_blocks_api')
"""
.. toggle_name: course_blocks_api.hide_access_denials
.. toggle_implementation: WaffleFlag
.. toggle_default: False
.. toggle_description: Waffle flag to hide access denial messages in the course blocks.
.. toggle_category: course api
.. toggle_use_cases: incremental_release, open_edx
.. toggle_creation_date: ??
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: ??
.. toggle_status: supported
"""
# .. toggle_name: course_blocks_api.hide_access_denials
# .. toggle_implementation: WaffleFlag
# .. toggle_default: False
# .. toggle_description: Waffle flag to hide access denial messages in the course blocks.
# .. toggle_category: course api
# .. toggle_use_cases: incremental_release, open_edx
# .. toggle_creation_date: ??
# .. toggle_expiration_date: None
# .. toggle_warnings: None
# .. toggle_tickets: ??
# .. toggle_status: supported
HIDE_ACCESS_DENIALS_FLAG = WaffleFlag(
waffle_namespace=COURSE_BLOCKS_API_NAMESPACE,
flag_name=u'hide_access_denials',

13
lms/djangoapps/courseware/toggles.py
View File

@@ -11,12 +11,14 @@ WAFFLE_FLAG_NAMESPACE = WaffleFlagNamespace(name='courseware')
# .. toggle_name: courseware.courseware_mfe
# .. toggle_implementation: ExperimentWaffleFlag
# .. 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_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_category: micro-frontend
# .. toggle_use_cases: incremental_release, open_edx
# .. toggle_creation_date: 2020-01-29
# .. toggle_expiration_date: 2020-12-31
# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and ENABLE_COURSEWARE_MICROFRONTEND.
# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and
# ENABLE_COURSEWARE_MICROFRONTEND.
# .. toggle_tickets: TNL-7000
# .. toggle_status: supported
REDIRECT_TO_COURSEWARE_MICROFRONTEND = ExperimentWaffleFlag(
@@ -26,12 +28,15 @@ REDIRECT_TO_COURSEWARE_MICROFRONTEND = ExperimentWaffleFlag(
# .. toggle_name: courseware.microfrontend_course_team_preview
# .. toggle_implementation: CourseWaffleFlag
# .. toggle_default: False
# .. 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_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_category: micro-frontend
# .. toggle_use_cases: incremental_release, open_edx
# .. toggle_creation_date: 2020-03-09
# .. toggle_expiration_date: 2020-12-31
# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and ENABLE_COURSEWARE_MICROFRONTEND.
# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and
# ENABLE_COURSEWARE_MICROFRONTEND.
# .. toggle_tickets: TNL-6982
# .. toggle_status: supported
COURSEWARE_MICROFRONTEND_COURSE_TEAM_PREVIEW = CourseWaffleFlag(

4
lms/djangoapps/discussion/config/settings.py
View File

@@ -6,7 +6,9 @@ from django.conf import settings
# .. toggle_name: FEATURES['ENABLE_FORUM_DAILY_DIGEST']
# .. toggle_implementation: DjangoSetting
# .. toggle_default: True
# .. toggle_description: Settings for forums/discussions to on/off daily digest feature. Set this to True if you want to enable users to subscribe and unsubscribe for daily digest. This setting enables deprecation of daily digest.
# .. toggle_description: Settings for forums/discussions to on/off daily digest
# feature. Set this to True if you want to enable users to subscribe and unsubscribe
# for daily digest. This setting enables deprecation of daily digest.
# .. toggle_category: discussion
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2020-03-09

3
lms/djangoapps/verify_student/toggles.py
View File

@@ -11,7 +11,8 @@ WAFFLE_FLAG_NAMESPACE = WaffleFlagNamespace(name='verify_student')
# .. toggle_name: verify_student.use_new_email_templates
# .. toggle_implementation: WaffleFlag
# .. toggle_default: False
# .. toggle_description: Supports staged rollout to students for a new email templates implementation for ID verification.
# .. toggle_description: Supports staged rollout to students for a new email templates
# implementation for ID verification.
# .. toggle_category: verify student
# .. toggle_use_cases: incremental_release, open_edx
# .. toggle_creation_date: 2020-06-25

105
lms/envs/common.py
View File

@@ -85,7 +85,8 @@ FEATURES = {
# .. toggle_name: DISPLAY_DEBUG_INFO_TO_STAFF
# .. toggle_implementation: DjangoSetting
# .. toggle_default: True
# .. toggle_description: Add a "Staff Debug" button to course modules for debugging by course staff.
# .. toggle_description: Add a "Staff Debug" button to course modules for debugging
# by course staff.
# .. toggle_use_cases: ?
# .. toggle_creation_date: 2015-09-04
# .. toggle_expiration_date: None
@@ -100,7 +101,8 @@ FEATURES = {
# .. toggle_name: DISABLE_START_DATES
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: When True, all courses will be active, regardless of start date.
# .. toggle_description: When True, all courses will be active, regardless of start
# date.
# .. toggle_use_cases: ?
# .. toggle_creation_date: ?
# .. toggle_expiration_date: None
@@ -134,12 +136,17 @@ FEATURES = {
# .. toggle_name: ENABLE_DISCUSSION_EMAIL_DIGEST
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: Set this to True if you want the discussion digest emails enabled automatically for new users. This will be set on all new account registrations.
# .. toggle_description: Set this to True if you want the discussion digest emails
# enabled automatically for new users. This will be set on all new account
# registrations.
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2014-08-19
# .. toggle_expiration_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.
# .. 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
# .. toggle_status: supported
'ENABLE_DISCUSSION_EMAIL_DIGEST': False,
@@ -147,7 +154,9 @@ FEATURES = {
# 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_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
@@ -163,7 +172,8 @@ 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_description: Allow course staff to change to student view of courseware by accessing the
# /course/{course_id}/masquerade url.
# .. toggle_use_cases: ?
# .. toggle_creation_date: 2013-04-13
# .. toggle_expiration_date: None
@@ -175,7 +185,8 @@ FEATURES = {
# .. 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.
# .. 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.
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2013-12-12
@@ -203,7 +214,9 @@ FEATURES = {
# .. toggle_name: ENABLE_XBLOCK_VIEW_ENDPOINT
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. 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_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_creation_date: 2014-03-14
# .. toggle_expiration_date: None
@@ -212,13 +225,15 @@ FEATURES = {
# .. toggle_status: supported
'ENABLE_XBLOCK_VIEW_ENDPOINT': False,
# Allows to configure the LMS to provide CORS headers to serve requests from other domains
# Allows to configure the LMS to provide CORS headers to serve requests from other
# domains
'ENABLE_CORS_HEADERS': False,
# Can be turned off if course lists need to be hidden. Effects views and templates.
'COURSES_ARE_BROWSABLE': True,
# Set to hide the courses list on the Learner Dashboard if they are not enrolled in any courses yet.
# Set to hide the courses list on the Learner Dashboard if they are not enrolled in
# any courses yet.
'HIDE_DASHBOARD_COURSES_UNTIL_ACTIVATED': False,
# Give a UI to show a student's submission history in a problem by the
@@ -258,7 +273,8 @@ FEATURES = {
# .. toggle_name: DISABLE_HONOR_CERTIFICATES
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: Set to True to disable honor certificates. Typically used when your installation only allows verified certificates, like courses.edx.org.
# .. toggle_description: Set to True to disable honor certificates. Typically used when your installation only
# allows verified certificates, like courses.edx.org.
# .. toggle_category: certificates
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2019-05-14
@@ -276,7 +292,10 @@ FEATURES = {
# .. toggle_name: RESTRICT_AUTOMATIC_AUTH
# .. toggle_implementation: DjangoSetting
# .. toggle_default: True
# .. toggle_description: Prevent auto auth from creating superusers or modifying existing users. Auto auth is a mechanism where superusers can simply modify attributes of other users by accessing the "/auto_auth url" with the right querystring parameters.
# .. toggle_description: Prevent auto auth from creating superusers or modifying existing users. Auto auth is a
# mechanism where superusers can simply modify attributes of other users by accessing the "/auto_auth url" with
# the right
# querystring parameters.
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2018-05-07
@@ -300,7 +319,8 @@ FEATURES = {
# 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_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_expiration_date: None
@@ -320,7 +340,8 @@ FEATURES = {
# .. toggle_name: ENABLE_COSMETIC_DISPLAY_PRICE
# .. toggle_implementation: DjangoSetting
# .. 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_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_creation_date: 2014-10-10
# .. toggle_expiration_date: None
@@ -360,7 +381,10 @@ FEATURES = {
# toggle_name: ENABLE_THIRD_PARTY_AUTH
# toggle_implementation: DjangoSetting
# toggle_default: False
# toggle_description: Turn on third-party auth. Disabled for now because full implementations 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_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
@@ -392,7 +416,9 @@ FEATURES = {
# .. toggle_name: ENABLE_COURSE_SORTING_BY_START_DATE
# .. toggle_implementation: DjangoSetting
# .. toggle_default: True
# .. 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_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_creation_date: 2015-03-27
# .. toggle_expiration_date: None
@@ -404,7 +430,9 @@ FEATURES = {
# .. toggle_name: ENABLE_COURSE_HOME_REDIRECT
# .. toggle_implementation: DjangoSetting
# .. toggle_default: True
# .. 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_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_creation_date: 2019-01-15
# .. toggle_expiration_date: None
@@ -420,7 +448,8 @@ FEATURES = {
# .. toggle_name: ENABLE_COMBINED_LOGIN_REGISTRATION_FOOTER
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: Display the standard footer in the login page. This feature can be overridden by a site-specific configuration.
# .. toggle_description: Display the standard footer in the login page. This feature can be overridden by a site-
# specific configuration.
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2016-06-24
@@ -471,7 +500,8 @@ FEATURES = {
# .. toggle_name: LICENSING
# .. toggle_implementation: DjangoSetting
# .. 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_description: Toggle platform-wide course licensing. The course.license attribute is then used to append
# license information to the courseware.
# .. toggle_use_cases: ?
# .. toggle_creation_date: 2015-05-14
# .. toggle_expiration_date: None
@@ -486,7 +516,9 @@ FEATURES = {
# .. toggle_name: ENABLE_COURSE_DISCOVERY
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. 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_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_creation_date: 2015-04-23
# .. toggle_expiration_date: None
@@ -542,11 +574,14 @@ FEATURES = {
# .. toggle_name: ENABLE_CSMH_EXTENDED
# .. toggle_implementation: DjangoSetting
# .. 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_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_expiration_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 "coursewarehistoryextended" from the INSTALLED_APPS and the "StudentModuleHistoryExtendedRouter" from the DATABASE_ROUTERS.
# .. 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
# .. toggle_status: supported
'ENABLE_CSMH_EXTENDED': True,
@@ -563,7 +598,8 @@ FEATURES = {
# .. toggle_name: ALLOW_PUBLIC_ACCOUNT_CREATION
# .. toggle_implementation: DjangoSetting
# .. toggle_default: True
# .. toggle_description: Allow public account creation. If this is disabled, users will no longer have access to the signup page.
# .. toggle_description: Allow public account creation. If this is disabled, users will no longer have access to
# the signup page.
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2017-04-12
@@ -602,7 +638,10 @@ FEATURES = {
# .. toggle_name: ENABLE_CHANGE_USER_PASSWORD_ADMIN
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: Whether to send an email for failed password reset attempts or not. This happens when a user asks for a password reset but they don't have an account associated to their email. This is useful for notifying users that they don't have an account associated with email addresses they believe they've registered with. This setting can be overridden by a site-specific configuration.
# .. toggle_description: Whether to send an email for failed password reset attempts or not. This happens when a
# user asks for a password reset but they don't have an account associated to their email. This is useful for
# notifying users that they don't have an account associated with email addresses they believe they've registered
# with. This setting can be overridden by a site-specific configuration.
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2017-07-20
@@ -625,7 +664,8 @@ FEATURES = {
# .. toggle_name: ENABLE_CHANGE_USER_PASSWORD_ADMIN
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: Set to True to enable changing a user password through django admin. This is disabled by default because enabling allows a method to bypass password policy.
# .. toggle_description: Set to True to enable changing a user password through django admin. This is disabled by
# default because enabling allows a method to bypass password policy.
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2020-02-21
@@ -638,14 +678,16 @@ FEATURES = {
# .. toggle_name: ENABLE_COURSEWARE_MICROFRONTEND
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: Set to True to enable the Courseware MFE at the platform level for global staff (see REDIRECT_TO_COURSEWARE_MICROFRONTEND for course rollout)
# .. toggle_description: Set to True to enable the Courseware MFE at the platform level for global staff (see
# REDIRECT_TO_COURSEWARE_MICROFRONTEND for course rollout)
# .. toggle_category: admin
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2020-03-05
# .. toggle_expiration_date: None
# .. toggle_tickets: 'https://github.com/edx/edx-platform/pull/23317'
# .. toggle_status: supported
# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and see REDIRECT_TO_COURSEWARE_MICROFRONTEND for rollout.
# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and see REDIRECT_TO_COURSEWARE_MICROFRONTEND for
# rollout.
'ENABLE_COURSEWARE_MICROFRONTEND': False,
# .. toggle_name: ENABLE_LOGISTRATION_MICROFRONTEND
@@ -680,8 +722,8 @@ FEATURES = {
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: A "work-around" feature toggle meant to help in cases where some file uploads are not
# discoverable. If enabled, will iterate through all possible file key suffixes up to the max for displaying
# file metadata in staff assessments.
# discoverable. If enabled, will iterate through all possible file key suffixes up to the max for displaying
# file metadata in staff assessments.
# .. toggle_category: ora
# .. toggle_use_cases: graceful_degradation
# .. toggle_creation_date: 2020-03-03
@@ -695,7 +737,7 @@ FEATURES = {
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: A "work-around" feature toggle meant to help in cases where some file uploads are not
# discoverable. If enabled, will pull file metadata from StudentModule.state for display in staff assessments.
# discoverable. If enabled, will pull file metadata from StudentModule.state for display in staff assessments.
# .. toggle_category: ora
# .. toggle_use_cases: graceful_degradation
# .. toggle_creation_date: 2020-03-03
@@ -708,7 +750,8 @@ FEATURES = {
# .. toggle_name: ENABLE_ORA_USERNAMES_ON_DATA_EXPORT
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: Set to True to add deanonymized usernames to ORA data report.
# .. toggle_description: Set to True to add deanonymized usernames to ORA data
# report.
# .. toggle_category: ora
# .. toggle_use_cases: incremental_release
# .. toggle_creation_date: 2020-06-11

3
openedx/core/djangoapps/user_api/accounts/toggles.py
View File

@@ -15,7 +15,8 @@ from openedx.core.djangoapps.waffle_utils import WaffleFlag
# .. toggle_use_cases: incremental_release, open_edx
# .. toggle_creation_date: 2019-04-11
# .. toggle_expiration_date: 2020-12-31
# .. toggle_warnings: Also set settings.ORDER_HISTORY_MICROFRONTEND_URL and site's ENABLE_ORDER_HISTORY_MICROFRONTEND.
# .. toggle_warnings: Also set settings.ORDER_HISTORY_MICROFRONTEND_URL and site's
# ENABLE_ORDER_HISTORY_MICROFRONTEND.
# .. toggle_tickets: DEPR-17
# .. toggle_status: supported
REDIRECT_TO_ORDER_HISTORY_MICROFRONTEND = WaffleFlag('order_history', 'redirect_to_microfrontend', __name__)

26
openedx/core/djangoapps/user_authn/config/waffle.py
View File

@@ -8,20 +8,18 @@ from openedx.core.djangoapps.waffle_utils import WaffleSwitch, WaffleSwitchNames
_WAFFLE_NAMESPACE = u'user_authn'
_WAFFLE_SWITCH_NAMESPACE = WaffleSwitchNamespace(name=_WAFFLE_NAMESPACE, log_prefix=u'UserAuthN: ')
"""
.. toggle_name: user_authn.enable_login_using_thirdparty_auth_only
.. toggle_implementation: WaffleSwitch
.. 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_category: authn
.. toggle_use_cases: incremental_release
.. toggle_creation_date: 2019-11-20
.. toggle_expiration_date: 2020-01-31
.. toggle_warnings: Requires THIRD_PARTY_AUTH_ONLY_DOMAIN to also be set.
.. toggle_tickets: ENT-2461
.. toggle_status: supported
"""
# .. toggle_name: user_authn.enable_login_using_thirdparty_auth_only
# .. toggle_implementation: WaffleSwitch
# .. 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_category: authn
# .. toggle_use_cases: incremental_release
# .. toggle_creation_date: 2019-11-20
# .. toggle_expiration_date: 2020-01-31
# .. toggle_warnings: Requires THIRD_PARTY_AUTH_ONLY_DOMAIN to also be set.
# .. toggle_tickets: ENT-2461
# .. toggle_status: supported
ENABLE_LOGIN_USING_THIRDPARTY_AUTH_ONLY = WaffleSwitch(
_WAFFLE_SWITCH_NAMESPACE,
'enable_login_using_thirdparty_auth_only',

56
openedx/core/djangoapps/video_pipeline/config/waffle.py
View File

@@ -8,37 +8,33 @@ from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag, WaffleFlag, W
# Videos Namespace
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_category: videos
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2018-08-03
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/18765
.. toggle_status: supported
"""
# .. 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_category: videos
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2018-08-03
# .. toggle_expiration_date: None
# .. toggle_warnings: None
# .. toggle_tickets: https://github.com/edx/edx-platform/pull/18765
# .. toggle_status: supported
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_category: videos
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2020-03-12
.. toggle_expiration_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
.. toggle_status: supported
"""
# .. 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_category: videos
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2020-03-12
# .. toggle_expiration_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
# .. toggle_status: supported
ENABLE_DEVSTACK_VIDEO_UPLOADS = 'enable_devstack_video_uploads'
ENABLE_VEM_PIPELINE = 'enable_vem_pipeline'

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

@@ -381,7 +381,8 @@ def _get_waffle_flag_custom_metrics_set():
# .. toggle_name: WAFFLE_FLAG_CUSTOM_METRICS
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False
# .. toggle_description: A list of waffle flag to track with custom metrics having values of (True, False, or Both).
# .. toggle_description: A list of waffle flag to track with custom metrics having
# values of (True, False, or Both).
# .. toggle_category: monitoring
# .. toggle_use_cases: opt_in
# .. toggle_creation_date: 2020-06-17

7
openedx/features/course_duration_limits/models.py
View File

@@ -22,10 +22,9 @@ class CourseDurationLimitConfig(StackedConfigurationModel):
.. toggle_name: CourseDurationLimitConfig.enabled
.. toggle_implementation: ConfigurationModel
.. toggle_default: False
.. 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_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_creation_date: 2018-11-02

6
openedx/features/course_experience/__init__.py
View File

@@ -94,7 +94,8 @@ COURSE_PRE_START_ACCESS_FLAG = WaffleFlag(WAFFLE_FLAG_NAMESPACE, 'pre_start_acce
# .. toggle_use_cases: monitored_rollout
# .. toggle_creation_date: 2017-06-19
# .. toggle_expiration_date: ???
# .. toggle_warnings: We are no longer integrating with CourseTalk, so this probably should be deprecated and the code for reviews should be removed.
# .. toggle_warnings: We are no longer integrating with CourseTalk, so this probably should be deprecated and the code
# for reviews should be removed.
# .. toggle_tickets: DEPR-48
# .. toggle_status: unsupported
SHOW_REVIEWS_TOOL_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'show_reviews_tool', __name__)
@@ -128,7 +129,8 @@ UPGRADE_DEADLINE_MESSAGE = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'upgrade_dead
# .. toggle_use_cases: opt_out
# .. toggle_creation_date: 2017-09-11
# .. toggle_expiration_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_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
# .. toggle_status: supported
LATEST_UPDATE_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'latest_update', __name__)