feat: Adds Help tab to Operator Dashboard

* Uses different variables for the Instructor help markdown vs the Operator help markdown * Fixes YAML formatting that was breaking translations
openedx · Nov 9, 2023 · a11a0e0 · a11a0e0
1 parent 1d17283
commit a11a0e0
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 5 deletions.
diff --git a/tutoraspects/plugin.py b/tutoraspects/plugin.py
@@ -50,12 +50,21 @@
         # in the ClickHouse database. Make sure that you understand the legal
         # consequences of data storage and privacy before turning this on!
         ("ASPECTS_ENABLE_PII", False),
-        # Set this to empty string/False to omit Help tabs from the dashboard.
+        # Markdown comprising the Help tab for the Operator and Instructor dashboards.
+        # Set to empty string/False to omit Help tab entirely from the dashboard.
         # Newlines and double-quotes must be escaped.
         (
-            "ASPECTS_HELP_MARKDOWN",
+            "ASPECTS_INSTRUCTOR_HELP_MARKDOWN",
             "## Help\\n"
-            "* [Aspects Reference](https://docs.openedx.org/projects/openedx-aspects/page/reference/)\\n"
+            "* [Aspects Reference]"
+            "(https://docs.openedx.org/projects/openedx-aspects/page/reference/instructor_reports.html)\\n"
+            "* [Superset Resources](https://github.com/apache/superset#resources)\\n",
+        ),
+        (
+            "ASPECTS_OPERATOR_HELP_MARKDOWN",
+            "## Help\\n"
+            "* [Aspects Reference]"
+            "(https://docs.openedx.org/projects/openedx-aspects/page/reference/operator_reports.html)\\n"
             "* [Superset Resources](https://github.com/apache/superset#resources)\\n",
         ),
         # ClickHouse xAPI settings

diff --git a/...aspects/build/aspects-superset/openedx-assets/assets/dashboards/Instructor_Dashboard.yaml b/...aspects/build/aspects-superset/openedx-assets/assets/dashboards/Instructor_Dashboard.yaml
@@ -611,7 +611,7 @@ position:
     children: []
     id: MARKDOWN-LGvs7A8_15
     meta:
-      code: "{{ASPECTS_HELP_MARKDOWN}}"
+      code: "{{ASPECTS_INSTRUCTOR_HELP_MARKDOWN}}"
       height: 60
       width: 12
     parents:
@@ -898,7 +898,9 @@ position:
     - TAB-7PGDduCA7
     - TAB-CLiLC4zxo
     - TAB-eE0OQxuju
-    {% if ASPECTS_HELP_MARKDOWN %}- TAB-nXpinnLEX{% endif %}
+    # {% if ASPECTS_INSTRUCTOR_HELP_MARKDOWN %}
+    - TAB-nXpinnLEX
+    # {% endif %}
     id: TABS-SNeKAJcjhd
     meta: {}
     parents:

diff --git a/...s/aspects/build/aspects-superset/openedx-assets/assets/dashboards/Operator_Dashboard.yaml b/...s/aspects/build/aspects-superset/openedx-assets/assets/dashboards/Operator_Dashboard.yaml
@@ -894,6 +894,18 @@ position:
     - ROW-mPSz65tZ7E
     - COLUMN-GDahqg06nQ
     type: MARKDOWN
+  MARKDOWN-fLG7yz1R1t:
+    children: []
+    id: MARKDOWN-fLG7yz1R1t
+    meta:
+      code: "{{ASPECTS_OPERATOR_HELP_MARKDOWN}}"
+      height: 50
+      width: 4
+    parents:
+    - ROOT_ID
+    - GRID_ID
+    - ROW-yuEVxRJ4Of
+    type: MARKDOWN
   ROOT_ID:
     children:
     - GRID_ID
@@ -1029,6 +1041,18 @@ position:
     - TABS-7nA6MwltSD
     - TAB-z7LunkNp63
     type: ROW
+  ROW-lcH-BIR2I:
+    children:
+    - MARKDOWN-fLG7yz1R1t
+    id: ROW-lcH-BIR2I
+    meta:
+      background: BACKGROUND_TRANSPARENT
+    parents:
+    - ROOT_ID
+    - GRID_ID
+    - TABS-7nA6MwltSD
+    - TAB-RtC9PHwXy
+    type: ROW
   TAB-6Mdnw3FZh:
     children:
     - ROW-Z0QlRyckta
@@ -1114,6 +1138,19 @@ position:
     - GRID_ID
     - TABS-7nA6MwltSD
     type: TAB
+  TAB-RtC9PHwXy:
+    children:
+    - ROW-lcH-BIR2I
+    id: TAB-RtC9PHwXy
+    meta:
+      defaultText: Tab title
+      placeholder: Tab title
+      text: Help
+    parents:
+    - ROOT_ID
+    - GRID_ID
+    - TABS-7nA6MwltSD
+    type: TAB
   TABS-7nA6MwltSD:
     children:
     - TAB-DE73B5pXm
@@ -1122,6 +1159,9 @@ position:
     - TAB-EygpebMa1
     - TAB-gvqU89mvT
     - TAB-z7LunkNp63
+    # {% if ASPECTS_OPERATOR_HELP_MARKDOWN %}
+    - TAB-RtC9PHwXy
+    # {% endif %}
     id: TABS-7nA6MwltSD
     meta: {}
     parents: