diff --git a/docs/_static/apply_button._new.png b/docs/_static/apply_button_new.png similarity index 100% rename from docs/_static/apply_button._new.png rename to docs/_static/apply_button_new.png diff --git a/docs/course_team/concepts/course_overview_dashboard.rst b/docs/course_team/concepts/course_overview_dashboard.rst index c095076..375ce84 100644 --- a/docs/course_team/concepts/course_overview_dashboard.rst +++ b/docs/course_team/concepts/course_overview_dashboard.rst @@ -8,7 +8,7 @@ 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 +.. 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. @@ -16,7 +16,7 @@ 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 +.. image:: /_static/enrollment_metrics_new.png Engagement Metrics: =================== @@ -25,21 +25,19 @@ These metrics give you information about users' engagement with the course and i .. 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 + + .. 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 + + .. 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 +.. 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 index eaa23b5..1345026 100644 --- a/docs/course_team/concepts/filters.rst +++ b/docs/course_team/concepts/filters.rst @@ -10,10 +10,11 @@ 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 +.. 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 + +.. 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. \ No newline at end of file diff --git a/docs/course_team/concepts/index.rst b/docs/course_team/concepts/index.rst index 9305d4b..ce06b80 100644 --- a/docs/course_team/concepts/index.rst +++ b/docs/course_team/concepts/index.rst @@ -7,9 +7,7 @@ Index role_and_permissions superset_overview - course_dashboard - atrisk_dashboard - individual_learner_dashbord 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 index 2262194..4e502f7 100644 --- a/docs/course_team/concepts/individual_learner_dashboard.rst +++ b/docs/course_team/concepts/individual_learner_dashboard.rst @@ -4,7 +4,7 @@ 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 +.. 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. diff --git a/docs/course_team/concepts/learner_groups_dashboard.rst b/docs/course_team/concepts/learner_groups_dashboard.rst index c9091cf..2a45a06 100644 --- a/docs/course_team/concepts/learner_groups_dashboard.rst +++ b/docs/course_team/concepts/learner_groups_dashboard.rst @@ -5,7 +5,7 @@ In the At-Risk Learner Dashboard Reports, you can review the learners' performan The charts of this dashboard apply cross-filters to charts whose data sets contain the same name. -.. image:: _/_static/at_risk_dashboard.png +.. 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. @@ -14,18 +14,21 @@ 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 + +.. 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 + +.. 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 + +.. image:: /_static/atrisk_performance.png -- **Help:** It takes you to the tool documentation. +- **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. diff --git a/docs/course_team/concepts/superset_overview.rst b/docs/course_team/concepts/superset_overview.rst index 0b774e1..ebdfec9 100644 --- a/docs/course_team/concepts/superset_overview.rst +++ b/docs/course_team/concepts/superset_overview.rst @@ -7,7 +7,7 @@ If you want to learn more about Superset, please visit the Concept section, or i 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 +.. 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. diff --git a/docs/course_team/how-tos/access_aspects.rst b/docs/course_team/how-tos/access_aspects.rst index 6592102..7e3c593 100644 --- a/docs/course_team/how-tos/access_aspects.rst +++ b/docs/course_team/how-tos/access_aspects.rst @@ -10,21 +10,21 @@ Steps #. Select the **Reports** tab. -.. image:: _/_static/reports_tab.png +.. image:: /_static/reports_tab.png There you will see the three principal dashboards of Aspects: the :doc: `Course Dashboard `, the :doc: `At-Risk Learner Dashboard `, and the `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 +.. image:: /_static/superset_link.png #. Click the **Allow** button. -.. image:: _/_static/superset_permissions.png +.. image:: /_static/superset_permissions.png #. Click **Sign in with Open edX SSO** button. -.. image:: _/_static/superset_singin.png +.. 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 index dc8b8bf..e4c2e31 100644 --- a/docs/course_team/how-tos/apply_filters.rst +++ b/docs/course_team/how-tos/apply_filters.rst @@ -10,23 +10,23 @@ Steps #. 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 +.. 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 +.. 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 +.. 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 +.. 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. diff --git a/docs/course_team/how-tos/apply_filters_lms.rst b/docs/course_team/how-tos/apply_filters_lms.rst index fa0f949..c157c15 100644 --- a/docs/course_team/how-tos/apply_filters_lms.rst +++ b/docs/course_team/how-tos/apply_filters_lms.rst @@ -10,20 +10,20 @@ Steps #. Expand the filters panel by clicking the expand icon on the side of the dashboard. -.. image:: _/_static/expand_filters.png +.. 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 +.. 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 +.. 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 +.. 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 index 56d28ec..80d1ddf 100644 --- a/docs/course_team/how-tos/cross_filter.rst +++ b/docs/course_team/how-tos/cross_filter.rst @@ -1,4 +1,4 @@ - How to Add or Remove a Cross-filter in an Aspects Dashboard +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. @@ -9,13 +9,13 @@ How to Add a Cross-Filter #. Select **Add cross-filter**. -.. image:: _/_static/add_cross_filter.png +.. 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 +.. image:: /_static/hover_filters.png How to Remove a Cross-filter **************************** @@ -23,6 +23,6 @@ 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 +.. 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 index 972c6c9..e8c8c1f 100644 --- a/docs/course_team/how-tos/download_reports.rst +++ b/docs/course_team/how-tos/download_reports.rst @@ -10,12 +10,13 @@ Steps #. Select the **Download** option. -.. image:: _/_static/download_button.png +.. 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. diff --git a/docs/course_team/how-tos/index.rst b/docs/course_team/how-tos/index.rst index cc0b7e3..d387327 100644 --- a/docs/course_team/how-tos/index.rst +++ b/docs/course_team/how-tos/index.rst @@ -11,5 +11,3 @@ Index 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 index ff4b5cd..81ffb02 100644 --- a/docs/course_team/how-tos/update_data.rst +++ b/docs/course_team/how-tos/update_data.rst @@ -7,7 +7,7 @@ The Refresh option will prompt Superset to retrieve the latest data from the dat #. Click on the **Refresh Dashboard** option. -.. image:: _/_static/refresh_button.png +.. image:: /_static/refresh_button.png Automatic Refresh ***************** @@ -15,7 +15,7 @@ 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 +.. 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 +.. image:: /_static/refresh_box.png diff --git a/docs/index.rst b/docs/index.rst index 627b39a..189978d 100644 --- 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 Quickstarts Reference + Course Team Indices and tables