From 69e041b1ebf8b33a35503aaf210d65b42ad8d38d Mon Sep 17 00:00:00 2001 From: Jayram Date: Tue, 9 Feb 2021 20:23:02 +0530 Subject: [PATCH] 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 c2fa5e5935..4449cbcb6c 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -530,6 +530,16 @@ FEATURES = { '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,