From 3127e5f7afb1152cac143f2b2f9cd7e45dda3ee6 Mon Sep 17 00:00:00 2001
From: Jayram <jramnai007@gmail.com>
Date: Tue, 9 Feb 2021 20:27:12 +0530
Subject: [PATCH] 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 4449cbcb6c..fb08629f3e 100644
--- a/lms/envs/common.py
+++ b/lms/envs/common.py
@@ -544,6 +544,15 @@ FEATURES = {
     '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