From dd55860da182cbc844670615692b95dc3d5f2616 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Boros?= Date: Mon, 8 Feb 2021 19:45:26 +0400 Subject: [PATCH] [TSD] [SE-3988] add annotations to instructor plugin settings (#26202) docs: add annotations to instructor plugin settings --- lms/djangoapps/instructor/settings/common.py | 80 ++++++++++++++++---- 1 file changed, 64 insertions(+), 16 deletions(-) diff --git a/lms/djangoapps/instructor/settings/common.py b/lms/djangoapps/instructor/settings/common.py index eb5c4db80a..c51499a12d 100644 --- a/lms/djangoapps/instructor/settings/common.py +++ b/lms/djangoapps/instructor/settings/common.py @@ -10,35 +10,83 @@ def plugin_settings(settings): settings.ANALYTICS_DASHBOARD_URL = "" settings.ANALYTICS_DASHBOARD_NAME = _('Your Platform Insights') settings.FEATURES.update({ - # Enable display of enrollment counts in instructor dash, analytics section + # .. toggle_name: FEATURES['DISPLAY_ANALYTICS_ENROLLMENTS'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: True + # .. toggle_description: Enable display of enrollment counts in instructor dashboard and + # analytics section. + # .. toggle_use_cases: opt_out + # .. toggle_creation_date: 2014-11-12 + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/5838 'DISPLAY_ANALYTICS_ENROLLMENTS': True, - # Display the 'Analytics' tab in the instructor dashboard for CCX courses. - # Note: This has no effect unless ANALYTICS_DASHBOARD_URL is already set, - # because without that setting, the tab does not show up for any courses. + # .. toggle_name: FEATURES['ENABLE_CCX_ANALYTICS_DASHBOARD_URL'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Display the 'Analytics' tab in the instructor dashboard for CCX courses. + # Note: This has no effect unless ANALYTICS_DASHBOARD_URL is already set, because without that + # setting, the tab does not show up for any courses. + # .. toggle_use_cases: opt_in + # .. toggle_creation_date: 2016-10-07 + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/13196 'ENABLE_CCX_ANALYTICS_DASHBOARD_URL': False, - # Disable instructor dash buttons for downloading course data - # when enrollment exceeds this number + # .. setting_name: FEATURES['MAX_ENROLLMENT_INSTR_BUTTONS'] + # .. setting_default: 200 + # .. setting_description: Disable instructor dashboard buttons for downloading course data + # when enrollment exceeds this number. The number indicates the maximum allowed enrollments + # for the course to be considered "small". Courses exceeding the upper limit of "small" + # courses will have disabled buttons at the instructor dashboard. 'MAX_ENROLLMENT_INSTR_BUTTONS': 200, - # Grade calculation started from the instructor dashboard will write grades - # CSV files to the configured storage backend and give links for downloads. + # .. toggle_name: FEATURES['ENABLE_GRADE_DOWNLOADS'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Enable grade CSV downloads from the instructor dashboard. Grade + # calculation started from the instructor dashboard will write grades CSV files to the + # configured storage backend and give links for downloads. + # .. toggle_use_cases: opt_in + # .. toggle_creation_date: 2016-07-06 + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/11286 'ENABLE_GRADE_DOWNLOADS': False, - # Give course staff unrestricted access to grade downloads (if set to False, - # only edX superusers can perform the downloads) + # .. toggle_name: FEATURES['ALLOW_COURSE_STAFF_GRADE_DOWNLOADS'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Enable to give course staff unrestricted access to grade downloads; + # if set to False, only edX superusers can perform the downloads. + # .. toggle_use_cases: opt_in + # .. toggle_creation_date: 2018-03-26 + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/1750 'ALLOW_COURSE_STAFF_GRADE_DOWNLOADS': False, - # Show a section in the membership tab of the instructor dashboard - # to allow an upload of a CSV file that contains a list of new accounts to create - # and register for course. + # .. toggle_name: FEATURES['ALLOW_AUTOMATED_SIGNUPS'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Enable to show a section in the membership tab of the instructor + # dashboard to allow an upload of a CSV file that contains a list of new accounts to create + # and register for course. + # .. toggle_use_cases: opt_in + # .. toggle_creation_date: 2014-10-21 + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/5670 'ALLOW_AUTOMATED_SIGNUPS': False, - # Batch-Generated Certificates from Instructor Dashboard + # .. toggle_name: FEATURES['CERTIFICATES_INSTRUCTOR_GENERATION'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: Enable to allow batch generation of certificates from the instructor dashboard. + # In case of self-paced courses, the certificate generation button is hidden if certificate + # generation is not explicitly enabled globally or for the specific course. + # .. toggle_use_cases: opt_in 'CERTIFICATES_INSTRUCTOR_GENERATION': False, - # Whether to check the "Notify users by email" checkbox in the batch enrollment form - # in the instructor dashboard. + # .. toggle_name: FEATURES['BATCH_ENROLLMENT_NOTIFY_USERS_DEFAULT'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: True + # .. toggle_description: Controls if the "Notify users by email" checkbox in the batch + # enrollment form on the instructor dashboard is already checked on page load or not. + # .. toggle_use_cases: opt_out + # .. toggle_creation_date: 2017-07-05 + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/15392 'BATCH_ENROLLMENT_NOTIFY_USERS_DEFAULT': True, })