openedx · Apgomeznext · Jun 24, 2024 · Jun 24, 2024 · bmtcril · Jun 24, 2024
diff --git a/docs/_static/add_cross_filter.png b/docs/_static/add_cross_filter.png
diff --git a/docs/_static/apply_button.png b/docs/_static/apply_button.png
diff --git a/docs/_static/apply_button_new.png b/docs/_static/apply_button_new.png
diff --git a/docs/_static/at_risk_dashboard.png b/docs/_static/at_risk_dashboard.png
diff --git a/docs/_static/atrisk_engagement.png b/docs/_static/atrisk_engagement.png
diff --git a/docs/_static/atrisk_performance.png b/docs/_static/atrisk_performance.png
diff --git a/docs/_static/autorefresh_option.png b/docs/_static/autorefresh_option.png
diff --git a/docs/_static/clear_button.png b/docs/_static/clear_button.png
diff --git a/docs/_static/course_dashboard_new.png b/docs/_static/course_dashboard_new.png
diff --git a/docs/_static/course_filters.png b/docs/_static/course_filters.png
diff --git a/docs/_static/download_button.png b/docs/_static/download_button.png
diff --git a/docs/_static/engagement_page.png b/docs/_static/engagement_page.png
diff --git a/docs/_static/engagement_problems_new.png b/docs/_static/engagement_problems_new.png
diff --git a/docs/_static/engagement_videos.png b/docs/_static/engagement_videos.png
diff --git a/docs/_static/enrollment_metrics_new.png b/docs/_static/enrollment_metrics_new.png
diff --git a/docs/_static/expand_filters.png b/docs/_static/expand_filters.png
diff --git a/docs/_static/filter_icon.png b/docs/_static/filter_icon.png
diff --git a/docs/_static/filters_panel.png b/docs/_static/filters_panel.png
diff --git a/docs/_static/hover_filters.png b/docs/_static/hover_filters.png
diff --git a/docs/_static/individual_dashboard.png b/docs/_static/individual_dashboard.png
diff --git a/docs/_static/performance_metrics.png b/docs/_static/performance_metrics.png
diff --git a/docs/_static/refresh_box.png b/docs/_static/refresh_box.png
diff --git a/docs/_static/refresh_button.png b/docs/_static/refresh_button.png
diff --git a/docs/_static/remove_cross_filter.png b/docs/_static/remove_cross_filter.png
diff --git a/docs/_static/reports_tab.png b/docs/_static/reports_tab.png
diff --git a/docs/_static/superset_link.png b/docs/_static/superset_link.png
diff --git a/docs/_static/superset_overview.png b/docs/_static/superset_overview.png
diff --git a/docs/_static/superset_permissions.png b/docs/_static/superset_permissions.png
diff --git a/docs/_static/superset_singin.png b/docs/_static/superset_singin.png
diff --git a/docs/_static/time_filters.png b/docs/_static/time_filters.png
diff --git a/docs/course_team/concepts/course_overview_dashboard.rst b/docs/course_team/concepts/course_overview_dashboard.rst
@@ -0,0 +1,43 @@
+Course Dashboard Reports
+########################
+
+In the Course Dashboard Report, you will find all the information related to the course performance, such as how many people have enrolled, how those people have consumed the course content, such as pages, problems, and videos, and how many people have passed the course.
+
+What Data Am I Looking At?
+**************************
+
+The number of current users enrolled in the course is displayed at the top left corner, and all the course information is on the right side.
+
+.. image:: /_static/course_dashboard_new.png
+
+Below this information, you can see the **Enrollment**, **Engagement**, and **Performance** data by clicking on the option you want to access. Also, you will find a **Help** tab to get redirected to the Aspects documentation.
+
+Enrollment Metrics:
+===================
+These metrics will give you a detailed report in the enrollment track showing the process behavior by time and type of enrollment. This can help you evaluate marketing campaigns for a particular course.
+
+.. image:: /_static/enrollment_metrics_new.png
+
+Engagement Metrics:
+===================
+These metrics give you information about users' engagement with the course and its specific content, particularly Pages, Problems, and Videos. To see these metrics, just choose the tab you want to see.
+- **Pages:** This tab shows page engagement metrics by section and subsection, cumulative interactions, and engagement over time.
+.. image:: _/_static/engagement_page.png
+
+- **Problems:** These metrics show the learners' engagement with the problems and assessments created in the course. The attempts and results information help understand each problem's performance.
+
+  .. image:: /_static/engagement_problems_new.png
+
+- **Videos:** These metrics show how the learners have engaged with your course video content, including how many partial and completed videos they have seen.
+
+  .. image:: /_static/engagement_videos.png
+
+Performance Metrics:
+====================
+These metrics show the learners' performance in the course according to their grades and the approval percentage.
+.. image:: /_static/performance_metrics.png
+
+
+.. note:: Remember that you can change the filters of these reports by accessing Superset through the link above the reports. For more information, visit the How-tos section.
+
+.. seealso:: If you want to refresh the information displayed in the report, click the **More Options** button (three vertical dots) in the upper right corner of each metric and select the Force Refresh option. For more information, visit the How-tos section.
diff --git a/docs/course_team/concepts/filters.rst b/docs/course_team/concepts/filters.rst
@@ -0,0 +1,20 @@
+Filters
+#######
+
+Superset dashboards allow you to filter the data displayed in the charts and graphs, which can help you focus on specific data sets or trends. 
+
+Types of Filters
+****************
+
+There are three main types of filters in Superset dashboards:
+
+- **Course Filters:** These filters allow you to specify which courses you want to see data for. For example, in the following image, the course filters include Organization, Course Name, and Course Run, which are currently set to specific examples.  
+
+.. image:: /_static/course_filters.png
+
+
+- **Time Filters:** These filters allow you to specify the period you want to see data for. The "Date" filter in the image is currently set to "No filter." There is also a "Time Grain" filter that you can use to change the time interval shown in the graph (e.g., day, week, month).
+
+.. image:: /_static/time_filters.png
+
+- **Individual Learner Filters:** These filters on the Individual Learner Dashboard allow you to filter the enrollment, engagement, and performance information for a single learner in your course at a time. By default, no filter is applied to the Name, Username, or Email filter.  
diff --git a/docs/course_team/concepts/index.rst b/docs/course_team/concepts/index.rst
@@ -0,0 +1,13 @@
+Index
+#####
+
+
+.. toctree::
+   :maxdepth: 2
+
+   role_and_permissions
+   superset_overview
+   filters
+   course_overview_dashboard
+   individual_learner_dashboard
+   learner_groups_dashboard
diff --git a/docs/course_team/concepts/individual_learner_dashboard.rst b/docs/course_team/concepts/individual_learner_dashboard.rst
@@ -0,0 +1,16 @@
+Individual Learner Dashboard Reports
+####################################
+
+The Individual Learner Dashboard Reports focus on relevant information about each learner’s performance and information, including course enrollment and activity logs, to give a general overview. If the name, username, and email address columns are empty in the learner summary, it is because your site operator has chosen to omit limited personally identifiable information from being displayed on your Open edX instance.
+
+
+.. image:: /_static/individual_dashboard.png
+
+As with the rest of the Aspects dashboards, this dashboard's charts apply cross-filters to charts whose data sets contain the same name. 
+
+One particular benefit of this dashboard is that it gives the course delivery team a general view of the course performance while zooming in and out on each learner, combining the Course Dashboard and At-Risk Learner Dashboard information.
+
+
+.. note:: Remember that you can change the filters of these reports by accessing Superset through the link above the reports. For more information, visit the How-tos section.
+
+.. seealso:: If you want to refresh the information displayed in the report, click the **More Options** button (three vertical dots) in the upper right corner of each metric and select the Force Refresh option. For more information, visit the How-tos section.
diff --git a/docs/course_team/concepts/learner_groups_dashboard.rst b/docs/course_team/concepts/learner_groups_dashboard.rst
@@ -0,0 +1,35 @@
+At-Risk Learner Dashboard Reports
+#################################
+
+In the At-Risk Learner Dashboard Reports, you can review the learners' performance to gain a clear perspective of their engagement and performance in the course and identify those at risk of abandoning or dropping the course. Learners who appear in this dashboard have enrolled in the course, have done something in the course other than visit the course homepage, have not yet passed the course, and have not visited the course in seven or more days. 
+
+The charts of this dashboard apply cross-filters to charts whose data sets contain the same name. 
+
+.. image:: /_static/at_risk_dashboard.png
+
+At the top of this dashboard, you will find five tabs: **Overview**, **Enrollment**, **Engagement**, **Performance**, and **Help**. Each tab shows different information you can filter, choosing one particular learner to understand their behavior and take any necessary action to intervene.
+
+In the tabs, you will find:
+
+- **Overview:** In this tab, you will find the list of learners with names, usernames, and emails above the last visit date to have a first metric to indicate a risk factor. If you select one user in this tab, that selection will filter the information of the rest of the tabs to show only the information linked to that user. If the name, username, and email address columns are empty, it is because your site operator has chosen to omit limited personally identifiable information from being displayed on your Open edX instance.
+
+- **Enrollment:** This tab has data on enrollment type and date.
+
+.. image:: /_static/at_risk_dashboard.png
+
+
+- **Engagement:** This tab contains a detailed report about the learners' interaction with the course content, particularly with the pages, problems, and videos. This tab will give you relevant information about the troubles the at-risk learner group has with the content in case you need to create an alternative route for them.
+
+.. image:: /_static/atrisk_engagement.png
+
+
+- **Performance:** This tab shows the course grades as a metric of the learner's performance to indicate the approval percentage.
+
+.. image:: /_static/atrisk_performance.png
+
+
+- **Help:** It takes you to the tool documentation.
+
+.. note::Remember that you can change the filters of these reports by accessing Superset through the link above the reports. For more information, visit the How-tos section.
+
+.. seealso::If you want to refresh the information displayed in the report, click the **More Options** button (three vertical dots) in the upper right corner of each metric and select the Force Refresh option. For more information, visit the How-tos section.
diff --git a/docs/course_team/concepts/role_and_permissions.rst b/docs/course_team/concepts/role_and_permissions.rst
@@ -0,0 +1,17 @@
+Role Description and Permissions
+################################
+
+As a course delivery team member, you may want to monitor the learners' performance to determine how to help them and evaluate the general course output, and Aspects can help you with that.
+
+What can you do in Aspects?
+===========================
+With this role, the course team members have access to the Course Dashboard, the At-Risk Learner Dashboard, and the Individual Learner Dashboard, depending on the type of dashboard created by the platform administrator. 
+You can generally navigate through the dashboards from the Instructor tab in the LMS and access Superset, the open-source data exploration and visualization tool used for Aspects, to modify the reports using the filters available. 
+You can also download information as a PDF or image to use or communicate it as you want.
+
+What you cannot do in Aspects?
+==============================
+The principal functions that are not available for the users with course delivery team roles are:
+- Create new dashboards.
+- Permit new course delivery team members. However, course admins can add course staff to their courses, who will then have access to Aspects.
+- Modify the general settings of the tool.
diff --git a/docs/course_team/concepts/superset_overview.rst b/docs/course_team/concepts/superset_overview.rst
@@ -0,0 +1,29 @@
+Superset Overview
+#################
+
+Apache Superset is an open-source platform that is the primary data visualization and exploration tool for Aspects. But here, more than explaining Superset's benefits, let us discuss how to navigate it. 
+
+If you want to learn more about Superset, please visit the Concept section, or if you want to learn more about why we chose this tool for the project, please visit the Decision section in the Technical Documentation.
+
+The Superset Home Page provides an overview of the dashboards available and quick access to different sections for managing your data visualizations.
+
+.. image:: /_static/superset_overview.png
+
+
+On the navigation bar at the top of the home page, you will find a series of buttons to access the tool's different options and configurations. Depending on your permissions, you might or might not have certain buttons or more options in certain menus.
+
+The buttons are:
+- **Dashboards:** This button leads you to a section where you can create and manage dashboards.
+- **Charts:** This button leads you to a section where you can create and manage charts.
+- **Datasets:** This button leads you to a section where you can manage datasets for your visualizations.
+- **SQL:** This button leads to a SQL editor where you can write and execute SQL queries.
+- **+:** This button allows you to create new dashboards or charts and add new SQL queries and data sets.
+- **Settings:** This button leads to a section where you can manage user settings and configure Superset.
+
+Below the navigation bar, you will find different sections where the dashboards and charts are organized to improve your platform navigation experience. Those sections are:
+- **Recents:** Here, you will find the latest dashboards and charts viewed or edited by you.
+- **Dashboards:** In this section, you will find all the dashboards published by your organization.
+- **Charts:** Here, you can access all the charts created by your organization for each course, like Video Engagement or Problem Attempts.
+- **Saved Queries:** This section will contain all the SQL queries you create, add, or edit on your organization’s Aspects.
+
+.. note:: This information is also relevant to users with administrator roles. 
diff --git a/docs/course_team/how-tos/access_aspects.rst b/docs/course_team/how-tos/access_aspects.rst
@@ -0,0 +1,30 @@
+How-to Access Aspects as a Course Delivery Team Member
+######################################################
+
+Once the Administrator has assigned you the course delivery team role and permitted you to do so, you will have access to the reports from the LMS by following these simple steps.
+
+Steps
+*****
+
+#. In the LMS, go to the **Instructor** Tab.
+
+#. Select the **Reports** tab.
+
+.. image:: /_static/reports_tab.png
+
+There you will see the three principal dashboards of Aspects: the :doc: `Course Dashboard <course_overview_dashboard>`, the :doc: `At-Risk Learner Dashboard <learner_groups_dashboard>`, and the `Individual Learner Dashboard <individual_learner_dashboard>`. From these dashboards, you will see the course and learner information that Aspects has collected.
+
+
+#. Above the dashboards, you will find a link to access the dashboards from Superset, modify the filters, and download the reports.
+
+.. image:: /_static/superset_link.png
+
+#. Click the **Allow** button.
+
+.. image:: /_static/superset_permissions.png
+
+#. Click **Sign in with Open edX SSO** button.
+
+.. image:: /_static/superset_singin.png
+
+.. note:: If the link to Superset does not appear, your site operator has elected to disable this link from being shown on your Open edX instance.
diff --git a/docs/course_team/how-tos/apply_filters.rst b/docs/course_team/how-tos/apply_filters.rst
@@ -0,0 +1,33 @@
+How To Apply Filters in a Superset Dashboard
+############################################
+
+The filters are one of the most important features that Aspects brings to edit the type of information that you can access. Let's see how to apply them in any of the dashboards.
+
+Steps
+*****
+
+#. Once you can access Superset, select the dashboard you want to work on.
+
+#. At the left panel, you will find all the filter categories that apply to the information dashboard. Click on the dropdown menu of the filters to see the option lists.
+
+.. image:: /_static/filters_panel.png
+
+#. To modify a filter, select the desired option from the list. You can also use the search bar to find specific courses or dates.
+
+#. Once you have selected your filters, click the **Apply Filters** button to update the dashboard.
+
+.. image:: /_static/apply_button_new.png
+
+#. Hover over the filter icon to view what filters have been applied to the chart or table.
+
+.. image:: /_static/hover_filters.png
+
+Clearing Filters
+****************
+The dashboard also has a **Clear All** button that you can use to remove all of the filters and reset the dashboard to its default state.
+
+.. image:: /_static/clear_button.png
+
+.. note:: You can apply multiple filters simultaneously. For example, you could filter the data to show only courses from a specific organization for a particular date range.
+
+.. note:: The available filters will depend on the specific dashboard you are viewing.
diff --git a/docs/course_team/how-tos/apply_filters_lms.rst b/docs/course_team/how-tos/apply_filters_lms.rst
@@ -0,0 +1,29 @@
+How To Apply Filters in the LMS View
+####################################
+
+Steps
+*****
+
+#. Navigate to the Aspects dashboard to be filtered.
+
+.. seealso:: To learn more about how to access to the Aspects Dashboard from the LMS, visit :doc:`How to Access Aspects  <access_aspects>`. 
+
+#. Expand the filters panel by clicking the expand icon on the side of the dashboard.
+
+.. image:: /_static/expand_filters.png
+
+#. Click into the input field for the field you want to apply a filter for and enter the filter value.
+
+#. Click the **Apply Filters** button at the bottom of the filters panel.
+
+.. image:: /_static/apply_button_new.png
+
+#. Depending on the dashboard filter that has been applied, not all charts or tables in an Aspects Dashboard will be filtered. The filter icon on the upper corner of each chart and table shows the number of filters that have been applied.
+
+.. image:: /_static/filter_icon.png
+
+#. Hover over the filter icon to view what filters have been applied to the chart or table.
+
+.. image:: /_static/hover_filters.png
+
+
diff --git a/docs/course_team/how-tos/cross_filter.rst b/docs/course_team/how-tos/cross_filter.rst
@@ -0,0 +1,28 @@
+How to Add or Remove a Cross-filter in an Aspects Dashboard
+############################################################
+
+Cross-filters are useful for applying the same filter to other charts and tables in the dashboard that use the same dataset. However, cross-filters are not available for all fields. For example, Adding a cross-filter for a single video on the Video Engagement tab of the Course Dashboard filters all applicable video tables and graphs to show only data for that video.
+
+How to Add a Cross-Filter
+*************************
+#. Right-click any cell, bar, or line graph element on a chart or table in an Aspects dashboard.
+
+#. Select **Add cross-filter**.
+
+.. image:: /_static/add_cross_filter.png
+
+.. note:: If the Add a cross-filter option is disabled, cross-filters are not available for that field.
+
+#. Hover over the filter icon to view what filters have been applied to the chart or table.
+
+.. image:: /_static/hover_filters.png
+
+How to Remove a Cross-filter
+****************************
+
+#. To remove an applied cross-filter, right-click any cell, bar, or line graph element on a chart or table in an Aspects dashboard.
+
+#. Select **Remove cross-filter**.
+.. image:: /_static/remove_cross_filter.png
+
+.. note:: A user can also click on the cell, bar, or line graph element as a shortcut for adding or removing a cross-filter.
diff --git a/docs/course_team/how-tos/download_reports.rst b/docs/course_team/how-tos/download_reports.rst
@@ -0,0 +1,24 @@
+Downloading Reports in Superset Dashboards
+##########################################
+
+The Superset dashboard allows you to download reports in PDF, CSV, and image formats. Here's how to do so. 
+
+Steps
+*****
+
+#. Go to the right side of the dashboard and click on the three dots button to spread the options menu.
+
+#. Select the **Download** option.
+
+.. image:: /_static/download_button.png
+
+#. You will have two options:
+
+- **Export to PDF:** This option will download a PDF report of the current dashboard view.
+- **Download as Image:** This option will download an image of the current dashboard view.
+
+Select the option you want to use; the document will download immediately.
+
+.. note:: The specific download options available may vary depending on the dashboard you are viewing.
+
+.. note:: Some dashboards may allow you to download additional data formats or customize the content of the downloaded report.
diff --git a/docs/course_team/how-tos/index.rst b/docs/course_team/how-tos/index.rst
@@ -0,0 +1,13 @@
+Index
+#####
+
+
+.. toctree::
+   :maxdepth: 2
+
+   access_aspects
+   apply_filters
+   apply_filters_lms
+   cross_filter
+   download_reports
+   update_data
diff --git a/docs/course_team/how-tos/update_data.rst b/docs/course_team/how-tos/update_data.rst
@@ -0,0 +1,21 @@
+How to Update the Data
+######################
+
+The Refresh option will prompt Superset to retrieve the latest data from the data source and update the charts on the dashboard. 
+
+#. Go to the right side of the dashboard and click on the three dots button to spread the options menu.
+
+#. Click on the **Refresh Dashboard** option.
+
+.. image:: /_static/refresh_button.png
+
+Automatic Refresh
+*****************
+
+In addition to manually refreshing the dashboard, you can also set up automatic refresh intervals. Superset allows you to set an auto-refresh interval for each dashboard. This way, the dashboards will automatically update themselves at the specified interval. 
+
+#. Select the Set auto-refresh interval option.
+.. image:: /_static/autofresh_option.png
+
+#. A box will open where you can select the frequency at which this data set will be refreshed. Once you have chosen the frequency, click **Save for this session** to save the changes.
+.. image:: /_static/refresh_box.png
diff --git a/docs/course_team/index.rst b/docs/course_team/index.rst
@@ -0,0 +1,16 @@
+Course Delivery Team User Documentation
+########################################
+
+.. toctree::
+   :maxdepth: 2
+
+   Concepts <concepts/index>
+   How-Tos <how-tos/index>
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,6 +19,7 @@ You can get started reading about the project in the :ref:`aspects-overview`, or
    How-Tos <how-tos/index>
    Quickstarts <quickstarts/index>
    Reference <reference/index>
+   Course Team <course_team/index>
 
 
 Indices and tables