diff --git a/docs/_static/course_dashboard_10_2024.png b/docs/_static/course_dashboard_10_2024.png new file mode 100644 index 0000000..f7e41ba Binary files /dev/null and b/docs/_static/course_dashboard_10_2024.png differ diff --git a/docs/_static/engagement_pages.png b/docs/_static/engagement_pages.png new file mode 100644 index 0000000..475429b Binary files /dev/null and b/docs/_static/engagement_pages.png differ diff --git a/docs/_static/engagement_problems.png b/docs/_static/engagement_problems.png new file mode 100644 index 0000000..f4941f8 Binary files /dev/null and b/docs/_static/engagement_problems.png differ diff --git a/docs/_static/engagement_videos.png b/docs/_static/engagement_videos.png deleted file mode 100644 index 0429845..0000000 Binary files a/docs/_static/engagement_videos.png and /dev/null differ diff --git a/docs/_static/engagement_videos_1.png b/docs/_static/engagement_videos_1.png new file mode 100644 index 0000000..6a034a0 Binary files /dev/null and b/docs/_static/engagement_videos_1.png differ diff --git a/docs/_static/engagement_videos_2.png b/docs/_static/engagement_videos_2.png new file mode 100644 index 0000000..3a07fec Binary files /dev/null and b/docs/_static/engagement_videos_2.png differ diff --git a/docs/_static/enrollees_and_course_info.png b/docs/_static/enrollees_and_course_info.png new file mode 100644 index 0000000..0de1893 Binary files /dev/null and b/docs/_static/enrollees_and_course_info.png differ diff --git a/docs/_static/help_tab.png b/docs/_static/help_tab.png new file mode 100644 index 0000000..ee2e5e4 Binary files /dev/null and b/docs/_static/help_tab.png differ diff --git a/docs/reference/course_overview_dashboard.rst b/docs/reference/course_overview_dashboard.rst index 3e095f6..eba9125 100644 --- a/docs/reference/course_overview_dashboard.rst +++ b/docs/reference/course_overview_dashboard.rst @@ -1,44 +1,75 @@ 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. +In the Course Dashboard Report, you will find all the information related to the course performance, like the number of people who 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? -************************** +.. image:: /_static/course_dashboard_10_2024.png -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. +What Is the Data on this Board? +******************************* -.. image:: /_static/course_dashboard_new.png +The information on this board is divided into three main blocks. -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. +1. Current Enrollments: +======================= + +The first block is in the upper left corner of the dashboard, where you will find the total number of people enrolled in the course. + +2. Course Information: +====================== +The second block is on the right side of Current Enrollments. This table concisely overviews key metrics for a specific course or course run. It is divided into several columns, each representing a different aspect of course performance. + +- **Organization:** This column indicates the organization to which a particular course is linked. It helps categorize courses and identify which ORG is responsible for them. +- **Course Key:** This column provides a unique identifier for the course, often a combination of letters and numbers. It distinguishes between different versions or iterations of the same course. +- **Course Name:** This column displays the course's title or name. It provides a human-readable label for easy identification. +- **Course Run:** This column specifies a particular instance or version of the course. It allows you to track the performance of different course offerings over time. +- **Active within the Last 7 Days:** This column shows the number of active learners in the course within the last seven days. It indicates current student engagement and activity. +- **Avg Course Grade:** This column displays the average grade achieved by all learners who have completed the course. It offers a measure of overall course performance. +- **Median Course Grade** This column represents the middle value of the course grades. It provides a more robust measure of central tendency compared to the mean, as it is less affected by outliers. + +.. image:: /_static/enrollees_and_course_info.png + +3. Enrollment, Engagement, Performance & Help: +============================================== + +The third section is under the Current Enrollees and Course Information table. 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 that will redirect you 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 +------------------- +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_pages.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. +**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.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. +**Videos:** These metrics show how the learners have engaged with your course video content, including how many partial and completed videos they have seen and how many times each five-second increment of video was viewed. - .. image:: /_static/engagement_videos.png +.. image:: /_static/engagement_videos_1.png + +.. image:: /_static/engagement_videos_2.png Performance Metrics: -==================== -These metrics show the learners' performance in the course according to their grades and the approval percentage. +-------------------- +These metrics show the learners’ performance in the course according to their grades and the approval percentage. .. image:: /_static/performance_metrics.png +Help tab: +--------- +The "Help" tab at the bottom of the course dashboard is a valuable resource for users seeking assistance or additional information. It typically provides quick access to relevant documentation and support materials related to the course and the platform. + +.. image:: /_static/help_tab.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. +.. 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-to's section `_.