From 69e041b1ebf8b33a35503aaf210d65b42ad8d38d Mon Sep 17 00:00:00 2001 From: Jayram Date: Tue, 9 Feb 2021 20:23:02 +0530 Subject: [PATCH 1/3] docs: add annotations for ENABLE_COURSEWARE_SEARCH feature flag --- lms/envs/common.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/lms/envs/common.py b/lms/envs/common.py index c2fa5e593563..4449cbcb6ce4 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -530,6 +530,16 @@ 'EXPOSE_CACHE_PROGRAMS_ENDPOINT': False, # Courseware search feature + # .. toggle_name: FEATURES['ENABLE_COURSEWARE_SEARCH'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: When enabled, this adds a Search the course widget on the course outline and courseware + # pages for searching courseware data. + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2015-01-29 + # .. toggle_warnings: In order to get this working, your courses data should be indexed in Elasticsearch. You will + # see the search widget on the courseware page only if the DISABLE_COURSE_OUTLINE_PAGE_FLAG is set. + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/6506 'ENABLE_COURSEWARE_SEARCH': False, 'ENABLE_COURSEWARE_SEARCH_FOR_COURSE_STAFF': False, From 3127e5f7afb1152cac143f2b2f9cd7e45dda3ee6 Mon Sep 17 00:00:00 2001 From: Jayram Date: Tue, 9 Feb 2021 20:27:12 +0530 Subject: [PATCH 2/3] docs: add annotations for ENABLE_DASHBOARD_SEARCH feature flag --- lms/envs/common.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lms/envs/common.py b/lms/envs/common.py index 4449cbcb6ce4..fb08629f3e6c 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -544,6 +544,15 @@ 'ENABLE_COURSEWARE_SEARCH_FOR_COURSE_STAFF': False, # Dashboard search feature + # .. toggle_name: FEATURES['ENABLE_DASHBOARD_SEARCH'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: When enabled, this adds a Search Your Courses widget on the dashboard page for searching + # courseware data. + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2015-01-29 + # .. toggle_warnings: In order to get this working, your courses data should be indexed in Elasticsearch. + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/6506 'ENABLE_DASHBOARD_SEARCH': False, # log all information from cybersource callbacks From 5ac505d5d0c7fc8ef85d293273b6053b79e502fb Mon Sep 17 00:00:00 2001 From: Jayram Date: Wed, 10 Feb 2021 19:35:38 +0530 Subject: [PATCH 3/3] docs: add annotations for ENABLE_COURSEWARE_SEARCH_FOR_COURSE_STAFF feature flag --- lms/envs/common.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/lms/envs/common.py b/lms/envs/common.py index fb08629f3e6c..9b0519fbfb83 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -541,6 +541,18 @@ # see the search widget on the courseware page only if the DISABLE_COURSE_OUTLINE_PAGE_FLAG is set. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/6506 'ENABLE_COURSEWARE_SEARCH': False, + + # .. toggle_name: FEATURES['ENABLE_COURSEWARE_SEARCH_FOR_COURSE_STAFF'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: When enabled, this adds a Search the course widget on the course outline and courseware + # pages for searching courseware data but for course staff users only. + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2019-12-06 + # .. toggle_warnings: In order to get this working, your courses data should be indexed in Elasticsearch. If + # ENABLE_COURSEWARE_SEARCH is enabled then the search widget will be visible to all learners and this flag's + # value does not matter in that case. This flag is enabled in devstack by default. + # .. toggle_tickets: https://openedx.atlassian.net/browse/TNL-6931 'ENABLE_COURSEWARE_SEARCH_FOR_COURSE_STAFF': False, # Dashboard search feature