diff --git a/docs/_static/activity_logs.png b/docs/_static/activity_logs.png new file mode 100644 index 0000000..d3ff020 Binary files /dev/null and b/docs/_static/activity_logs.png differ diff --git a/docs/_static/add_alert.png b/docs/_static/add_alert.png new file mode 100644 index 0000000..19d570e Binary files /dev/null and b/docs/_static/add_alert.png differ diff --git a/docs/_static/add_cross_filter.png b/docs/_static/add_cross_filter.png new file mode 100644 index 0000000..33f3206 Binary files /dev/null and b/docs/_static/add_cross_filter.png differ diff --git a/docs/_static/apply_button.png b/docs/_static/apply_button.png new file mode 100644 index 0000000..101fa87 Binary files /dev/null and b/docs/_static/apply_button.png differ diff --git a/docs/_static/apply_button_new.png b/docs/_static/apply_button_new.png new file mode 100644 index 0000000..b2fb897 Binary files /dev/null and b/docs/_static/apply_button_new.png differ diff --git a/docs/_static/at_risk_dashboard.png b/docs/_static/at_risk_dashboard.png new file mode 100644 index 0000000..4f8d854 Binary files /dev/null and b/docs/_static/at_risk_dashboard.png differ diff --git a/docs/_static/atrisk_engagement.png b/docs/_static/atrisk_engagement.png new file mode 100644 index 0000000..198f2e2 Binary files /dev/null and b/docs/_static/atrisk_engagement.png differ diff --git a/docs/_static/atrisk_performance.png b/docs/_static/atrisk_performance.png new file mode 100644 index 0000000..33ac4bd Binary files /dev/null and b/docs/_static/atrisk_performance.png differ diff --git a/docs/_static/autorefresh_option.png b/docs/_static/autorefresh_option.png new file mode 100644 index 0000000..a869f2c Binary files /dev/null and b/docs/_static/autorefresh_option.png differ diff --git a/docs/_static/clear_button.png b/docs/_static/clear_button.png new file mode 100644 index 0000000..ba74027 Binary files /dev/null and b/docs/_static/clear_button.png differ diff --git a/docs/_static/course_dashboard_new.png b/docs/_static/course_dashboard_new.png new file mode 100644 index 0000000..169bd55 Binary files /dev/null and b/docs/_static/course_dashboard_new.png differ diff --git a/docs/_static/course_filters.png b/docs/_static/course_filters.png new file mode 100644 index 0000000..cf2a76b Binary files /dev/null and b/docs/_static/course_filters.png differ diff --git a/docs/_static/database_connect.png b/docs/_static/database_connect.png new file mode 100644 index 0000000..e3b15b8 Binary files /dev/null and b/docs/_static/database_connect.png differ diff --git a/docs/_static/database_settings.png b/docs/_static/database_settings.png new file mode 100644 index 0000000..43cfed9 Binary files /dev/null and b/docs/_static/database_settings.png differ diff --git a/docs/_static/database_type.png b/docs/_static/database_type.png new file mode 100644 index 0000000..94c5f40 Binary files /dev/null and b/docs/_static/database_type.png differ diff --git a/docs/_static/download_button.png b/docs/_static/download_button.png new file mode 100644 index 0000000..8b4f30f Binary files /dev/null and b/docs/_static/download_button.png differ diff --git a/docs/_static/edit_role.png b/docs/_static/edit_role.png new file mode 100644 index 0000000..2ae8500 Binary files /dev/null and b/docs/_static/edit_role.png differ diff --git a/docs/_static/engagement_page.png b/docs/_static/engagement_page.png new file mode 100644 index 0000000..4da0c3f Binary files /dev/null and b/docs/_static/engagement_page.png differ diff --git a/docs/_static/engagement_problems_new.png b/docs/_static/engagement_problems_new.png new file mode 100644 index 0000000..10ca77b Binary files /dev/null and b/docs/_static/engagement_problems_new.png differ diff --git a/docs/_static/engagement_videos.png b/docs/_static/engagement_videos.png new file mode 100644 index 0000000..0429845 Binary files /dev/null and b/docs/_static/engagement_videos.png differ diff --git a/docs/_static/enrollment_metrics_new.png b/docs/_static/enrollment_metrics_new.png new file mode 100644 index 0000000..58c6f6c Binary files /dev/null and b/docs/_static/enrollment_metrics_new.png differ diff --git a/docs/_static/expand_filters.png b/docs/_static/expand_filters.png new file mode 100644 index 0000000..5e8d5fa Binary files /dev/null and b/docs/_static/expand_filters.png differ diff --git a/docs/_static/export_options.png b/docs/_static/export_options.png new file mode 100644 index 0000000..b6988c9 Binary files /dev/null and b/docs/_static/export_options.png differ diff --git a/docs/_static/filter_icon.png b/docs/_static/filter_icon.png new file mode 100644 index 0000000..e2b936a Binary files /dev/null and b/docs/_static/filter_icon.png differ diff --git a/docs/_static/filters_panel.png b/docs/_static/filters_panel.png new file mode 100644 index 0000000..4ea3c2a Binary files /dev/null and b/docs/_static/filters_panel.png differ diff --git a/docs/_static/hover_filters.png b/docs/_static/hover_filters.png new file mode 100644 index 0000000..f543843 Binary files /dev/null and b/docs/_static/hover_filters.png differ diff --git a/docs/_static/individual_dashboard.png b/docs/_static/individual_dashboard.png new file mode 100644 index 0000000..3996ee4 Binary files /dev/null and b/docs/_static/individual_dashboard.png differ diff --git a/docs/_static/moreoptions_button.png b/docs/_static/moreoptions_button.png new file mode 100644 index 0000000..37002c0 Binary files /dev/null and b/docs/_static/moreoptions_button.png differ diff --git a/docs/_static/new_record.png b/docs/_static/new_record.png new file mode 100644 index 0000000..39c9808 Binary files /dev/null and b/docs/_static/new_record.png differ diff --git a/docs/_static/operator_dashboard.png b/docs/_static/operator_dashboard.png new file mode 100644 index 0000000..cb1009a Binary files /dev/null and b/docs/_static/operator_dashboard.png differ diff --git a/docs/_static/performance_metrics.png b/docs/_static/performance_metrics.png new file mode 100644 index 0000000..ac33e20 Binary files /dev/null and b/docs/_static/performance_metrics.png differ diff --git a/docs/_static/refresh_box.png b/docs/_static/refresh_box.png new file mode 100644 index 0000000..d48f840 Binary files /dev/null and b/docs/_static/refresh_box.png differ diff --git a/docs/_static/refresh_button.png b/docs/_static/refresh_button.png new file mode 100644 index 0000000..7435863 Binary files /dev/null and b/docs/_static/refresh_button.png differ diff --git a/docs/_static/remove_cross_filter.png b/docs/_static/remove_cross_filter.png new file mode 100644 index 0000000..2b9e594 Binary files /dev/null and b/docs/_static/remove_cross_filter.png differ diff --git a/docs/_static/reports_tab.png b/docs/_static/reports_tab.png new file mode 100644 index 0000000..6639207 Binary files /dev/null and b/docs/_static/reports_tab.png differ diff --git a/docs/_static/security.png b/docs/_static/security.png new file mode 100644 index 0000000..5f2c637 Binary files /dev/null and b/docs/_static/security.png differ diff --git a/docs/_static/superset_link.png b/docs/_static/superset_link.png new file mode 100644 index 0000000..9e3f98c Binary files /dev/null and b/docs/_static/superset_link.png differ diff --git a/docs/_static/superset_overview.png b/docs/_static/superset_overview.png new file mode 100644 index 0000000..7d58656 Binary files /dev/null and b/docs/_static/superset_overview.png differ diff --git a/docs/_static/superset_permissions.png b/docs/_static/superset_permissions.png new file mode 100644 index 0000000..b903363 Binary files /dev/null and b/docs/_static/superset_permissions.png differ diff --git a/docs/_static/superset_singin.png b/docs/_static/superset_singin.png new file mode 100644 index 0000000..fbe7fcb Binary files /dev/null and b/docs/_static/superset_singin.png differ diff --git a/docs/_static/time_filters.png b/docs/_static/time_filters.png new file mode 100644 index 0000000..9b0eb0f Binary files /dev/null and b/docs/_static/time_filters.png differ diff --git a/docs/_static/viewall_button.png b/docs/_static/viewall_button.png new file mode 100644 index 0000000..4d39990 Binary files /dev/null and b/docs/_static/viewall_button.png differ diff --git a/docs/administator/concepts/index.rst b/docs/administator/concepts/index.rst new file mode 100644 index 0000000..eec3288 --- /dev/null +++ b/docs/administator/concepts/index.rst @@ -0,0 +1,10 @@ +Concepts +######## + + +.. toctree:: + :maxdepth: 2 + + role_description + permissions + diff --git a/docs/administator/concepts/permissions.rst b/docs/administator/concepts/permissions.rst new file mode 100644 index 0000000..6e209ed --- /dev/null +++ b/docs/administator/concepts/permissions.rst @@ -0,0 +1,12 @@ +Permissions +########### + +The permissions work by consulting the LMS APIs, the permission used is “course_staff.” Once granted, users are able to enter the LMS and assume the role of instructor, with which they can visit the assigned dashboard to its language code. + +Please refer to the `Superset official documentation `_ for more information. + +Manage Roles +************ +New roles and assignment rules can be created for them, and their permissions must also be configured. Those can be added programmatically, allowing you better control over their deployment and synchronization, or manually. This is not recommended, as the state of the installation can not be readily determined from the source code and can cause weird behavior. + +To learn more about this topic, review the `technical documentation `_. diff --git a/docs/administator/concepts/role_description.rst b/docs/administator/concepts/role_description.rst new file mode 100644 index 0000000..5707dac --- /dev/null +++ b/docs/administator/concepts/role_description.rst @@ -0,0 +1,27 @@ +Role Description +################ + +A Site Operator, also referred to as an Administrator, in Aspects holds the highest level of permissions within the platform. They possess complete control over user access, data, and configurations and are considered Super Users. + +Here's a breakdown of their key responsibilities: + +- **User Management:** + - Creating, editing, and deleting user accounts. + - Assigning roles and permissions to users and determining their access level to data sources, dashboards, and functionalities. + +- **Data Source Management:** + - Adding, configuring, and editing data sources that provide information for visualizations. + - Ensuring secure connections and proper data retrieval from various sources. + +- **Security Administration:** + - Maintaining the overall security of Superset by configuring authentication methods and access controls. + - Monitoring user activity and addressing any security concerns. + +- **System Administration:** + - Configuring global settings for Superset, such as date/time formats and display options. + - Managing system resources and ensuring smooth operation of the platform. + +- **Content Management:** + - While not exclusive to Site Operators, they have full access to create, edit, and share dashboards and reports within Superset. + +Site Operators act as Superset's system administrators, granting access, ensuring data security, and overseeing the platform's overall functionality. \ No newline at end of file diff --git a/docs/administator/how_to/activity_logs.rst b/docs/administator/how_to/activity_logs.rst new file mode 100644 index 0000000..73d7614 --- /dev/null +++ b/docs/administator/how_to/activity_logs.rst @@ -0,0 +1,18 @@ +How to Explore the Activity Logs of Superset Users +################################################## + +1. Go to your platform's Superset site. Remember that you can use the link in the LMS Instructor Tab. Visit `How to Access Aspects `_ to refresh your knowledge of this process. + +2. Log in to Superset with your administrator credentials. + +3. Locate the **Security** section of the **Settings menu**. + +.. image:: /_static/security.png + +4. Access the **Action Log** option. + +5. You can see and filter different users' recent activity on the platform. + +6. Click on the **Show Record** icon to see the details of each event. + +.. image:: /_static/activity_logs.png diff --git a/docs/administator/how_to/alerts_and_reports.rst b/docs/administator/how_to/alerts_and_reports.rst new file mode 100644 index 0000000..569c833 --- /dev/null +++ b/docs/administator/how_to/alerts_and_reports.rst @@ -0,0 +1,20 @@ +How to Manage Alerts and Reports +################################ + +Superset provides robust functionality for managing alerts and reports. Users can set up automated notifications based on data thresholds and schedule the delivery of reports to designated recipients. This feature enhances data-driven decision-making by ensuring stakeholders receive timely insights and updates. + +1. Go to your platform's Superset site. Remember that you can use the link in the LMS Instructor Tab. Visit `How to Access Aspects `_ to refresh your knowledge of this process. + +2. Log in to Superset with your administrator credentials. + +3. Locate the **Manage** section of the **Settings menu**. + +4. Access the **Alerts and Reports** option to see the list. + +5. Click the **+ Alert** button to add a new alert or the edit icon to edit an existing one. + +.. image:: /_static/add_alert.png + +6. Add a notification method to have the alert be sent by email and configure the email recipients. + +7. Finally, hit **Add** to have this automation in place. \ No newline at end of file diff --git a/docs/administator/how_to/create_new_role.rst b/docs/administator/how_to/create_new_role.rst new file mode 100644 index 0000000..a4e9e86 --- /dev/null +++ b/docs/administator/how_to/create_new_role.rst @@ -0,0 +1,20 @@ +How to Create a New Role +######################## + +1. Go to your platform's Superset site. Remember that you can use the link in the LMS Instructor Tab. Visit `How to Access Aspects `_ to refresh your knowledge of this process. + +2. Log in to Superset with your administrator credentials. + +3. Locate the **Security** section of the **Settings menu**. + +.. image:: /_static/security.png + +4. Access the **List Roles** option to see the list of roles. + +5. Click the **Add New Record** button to add a new role or the edit icon to edit an existing one. + +.. image:: /_static/new_record.png + +6. Fill in the required information and click **Save**. + +.. image:: /_static/edit_role.png diff --git a/docs/administator/how_to/database_connections.rst b/docs/administator/how_to/database_connections.rst new file mode 100644 index 0000000..2eadeab --- /dev/null +++ b/docs/administator/how_to/database_connections.rst @@ -0,0 +1,26 @@ +How to Manage Additional Database Connections +############################################# + +Superset allows users to efficiently manage database connections by providing a user-friendly interface for configuring, testing, and maintaining connections to various data sources. This feature streamlines the process of connecting to databases, making it easier for users to access and analyze their data within the platform and potentially across other platforms or data sources. + +1. Go to your platform's Superset site. Remember that you can use the link in the LMS Instructor Tab. Visit `How to Access Aspects `_ to refresh your knowledge of this process. + +2. Log in to Superset with your administrator credentials. + +3. Locate the **Data** section of the **Settings menu**. + +4. Access the **Database Connections** option to see the list. + +5. Click the **+ Database** button to add a new database connection or the edit icon to edit an existing one. + +6. Select the type of database. + +.. image:: /_static/database_type.png + +7. Provide the required information and click **Connect**. + +.. image:: /_static/database_connect.png + +8. Adjust the settings for the new connection and click **Finish**. + +.. image:: /_static/database_settings.png \ No newline at end of file diff --git a/docs/administator/how_to/export_tabular_data.rst b/docs/administator/how_to/export_tabular_data.rst new file mode 100644 index 0000000..ce5f375 --- /dev/null +++ b/docs/administator/how_to/export_tabular_data.rst @@ -0,0 +1,18 @@ +How to Export Tabular Data from a Chart or Table in an Aspects Dashboard +######################################################################### + +You can download data from Superset in different formats, but probably the most relevant for any Site Operator is how to export tabular data from a chart or table. + +1. Click the three-dot icon in the upper corner of any chart or table in an Aspects dashboard. + +.. image:: /_static/moreoptions_button.png + +2. Select **Download**. + +3. Select **Export to CSV** to export the table as a CSV file or **Export to Excel** to export the table as an Excel file. + +.. image:: /_static/export_options.png + +4. The exported file will appear in your **Downloads** folder. + +.. seealso:: To learn how to export information as a PDF or as an image, visit `How to Downloading Reports in Superset Dashboards `_. \ No newline at end of file diff --git a/docs/administator/how_to/index.rst b/docs/administator/how_to/index.rst new file mode 100644 index 0000000..6eb15f5 --- /dev/null +++ b/docs/administator/how_to/index.rst @@ -0,0 +1,13 @@ +How-to's +######### + + +.. toctree:: + :maxdepth: 2 + + create_new_role + activity_logs + database_connections + alerts_and_reports + view_data + export_tabular_data diff --git a/docs/administator/how_to/view_data.rst b/docs/administator/how_to/view_data.rst new file mode 100644 index 0000000..076b758 --- /dev/null +++ b/docs/administator/how_to/view_data.rst @@ -0,0 +1,13 @@ +How to View Data About an Open edX Instance +########################################### + +1. Once you access Superset with administrator credentials, go to the **Operator Dashboard**. + +.. image:: /_static/operator_dashboard.png + +2. Click the **View All button** if the **Operator Dashboard** doesn’t appear in the Dashboards Section. + +.. image:: /_static/viewall_button.png + +3. Find and click the link to the Operator Dashboard from the list of all available dashboards. + diff --git a/docs/administator/index.rst b/docs/administator/index.rst new file mode 100644 index 0000000..dc84d21 --- /dev/null +++ b/docs/administator/index.rst @@ -0,0 +1,10 @@ +Administrator and Site Operator User Documentation +################################################## + +.. toctree:: + :maxdepth: 2 + + Concepts + How-To's + Reference + diff --git a/docs/administator/reference/index.rst b/docs/administator/reference/index.rst new file mode 100644 index 0000000..c87f592 --- /dev/null +++ b/docs/administator/reference/index.rst @@ -0,0 +1,26 @@ +Reference +######### + +Advanced Configuration Options in ASPECTS +***************************************** + +By modifying the configuration files, you can alter the ASPECTs platform differently. + +You can configure whether to sync personal information such as user profiles and IDs. + +Sentry can be configured in all three services (LMS, Superset, and Ralph) + +Extra requirements can be added to the Superset. + +Extra Jinja filters can be added, allowing permission checks for other roles and filtering information based on information from other services. +You can change the default language, although the current ASPECTS version only focuses on English language support. + +Visit the official superset documentation to find out more: ``_. + +Branding +******** +Branding is not currently configurable for Aspects. This means that the superset logo will be visible on all the consoles. However, there is ongoing work to make it configurable to some extent. ``_. + +Configure Aspects for Production +******************************** +To have more information about the diferent posibilities that you have with Aspects, please visit the `Production Configuration Documents `_ diff --git a/docs/course_team/concepts/filters.rst b/docs/course_team/concepts/filters.rst new file mode 100644 index 0000000..1345026 --- /dev/null +++ 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. \ No newline at end of file diff --git a/docs/course_team/concepts/index.rst b/docs/course_team/concepts/index.rst new file mode 100644 index 0000000..95545c1 --- /dev/null +++ b/docs/course_team/concepts/index.rst @@ -0,0 +1,11 @@ +Concepts +######## + + +.. toctree:: + :maxdepth: 2 + + role_and_permissions + superset_overview + filters + diff --git a/docs/course_team/concepts/role_and_permissions.rst b/docs/course_team/concepts/role_and_permissions.rst new file mode 100644 index 0000000..da03808 --- /dev/null +++ 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. \ No newline at end of file diff --git a/docs/course_team/concepts/superset_overview.rst b/docs/course_team/concepts/superset_overview.rst new file mode 100644 index 0000000..06d4121 --- /dev/null +++ b/docs/course_team/concepts/superset_overview.rst @@ -0,0 +1,39 @@ +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. \ No newline at end of file diff --git a/docs/course_team/how-tos/access_aspects.rst b/docs/course_team/how-tos/access_aspects.rst new file mode 100644 index 0000000..15ea499 --- /dev/null +++ b/docs/course_team/how-tos/access_aspects.rst @@ -0,0 +1,27 @@ +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. + +1. In the LMS, go to the **Instructor** Tab. + +2. Select the **Reports** tab. + +.. image:: /_static/reports_tab.png + +There you will see the three principal dashboards of Aspects: the `Course Dashboard `_, the `Individual Learner Dashboard `_, and the `At Risk Learner Dashboard `_. From these dashboards, you will see the course and learner information that Aspects has collected. + + +3. 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 + +4. Click the **Allow** button. + +.. image:: /_static/superset_permissions.png + +5. 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 new file mode 100644 index 0000000..8974022 --- /dev/null +++ b/docs/course_team/how-tos/apply_filters.rst @@ -0,0 +1,30 @@ +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. + +1. Once you can access Superset, select the dashboard you want to work on. + +2. 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 + +3. To modify a filter, select the desired option from the list. You can also use the search bar to find specific courses or dates. + +4. Once you have selected your filters, click the **Apply Filters** button to update the dashboard. + +.. image:: /_static/apply_button_new.png + +5. 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 new file mode 100644 index 0000000..8d37f02 --- /dev/null +++ b/docs/course_team/how-tos/apply_filters_lms.rst @@ -0,0 +1,24 @@ +How to Apply Filters in the LMS View +#################################### + +1. 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 `. + +2. Expand the filters panel by clicking the expand icon on the side of the dashboard. + +.. image:: /_static/expand_filters.png + +3. Click into the input field for the field you want to apply a filter for and enter the filter value. + +4. Click the **Apply Filters** button at the bottom of the filters panel. + +.. image:: /_static/apply_button_new.png + +5. 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 + +6. Hover over the filter icon to view what filters have been applied to the chart or table. + +.. image:: /_static/hover_filters.png \ No newline at end of file diff --git a/docs/course_team/how-tos/cross_filter.rst b/docs/course_team/how-tos/cross_filter.rst new file mode 100644 index 0000000..6030223 --- /dev/null +++ b/docs/course_team/how-tos/cross_filter.rst @@ -0,0 +1,29 @@ +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 +************************* +1. Right-click any cell, bar, or line graph element on a chart or table in an Aspects dashboard. + +2. 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. + +3. 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 +**************************** + +1. To remove an applied cross-filter, right-click any cell, bar, or line graph element on a chart or table in an Aspects dashboard. + +2. 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 new file mode 100644 index 0000000..faf4f31 --- /dev/null +++ b/docs/course_team/how-tos/download_reports.rst @@ -0,0 +1,21 @@ +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. + +1. Go to the right side of the dashboard and click on the three dots button to spread the options menu. + +2. Select the **Download** option. + +.. image:: /_static/download_button.png + +3. 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. + +4. 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 new file mode 100644 index 0000000..8d3f5f9 --- /dev/null +++ b/docs/course_team/how-tos/index.rst @@ -0,0 +1,13 @@ +How-To's +######## + + +.. 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 new file mode 100644 index 0000000..c0c22e9 --- /dev/null +++ b/docs/course_team/how-tos/update_data.rst @@ -0,0 +1,23 @@ +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. + +1. Select the Set auto-refresh interval option. + +.. image:: /_static/autorefresh_option.png + +2. 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 new file mode 100644 index 0000000..5924b47 --- /dev/null +++ b/docs/course_team/index.rst @@ -0,0 +1,8 @@ +Course Delivery Team User Documentation +######################################## + +.. toctree:: + :maxdepth: 2 + + Concepts + How-To's diff --git a/docs/index.rst b/docs/index.rst index 627b39a..ff7e521 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,29 +1,30 @@ Welcome to the Open edX Aspects documentation! ============================================== -Aspects is an analytics system for Open edX, bringing actionable data about course and learner performance to instructors and site operators. It is primarily a Tutor plugin that ties together data from the Open edX learning management system and Studio using open source tools to aggregate and transform learning traces into data visualizations. +Aspects is an analytics system for Open edX that brings course delivery teams and site operators actionable data about course and learner performance. It is primarily a Tutor plugin that combines data from the Open edX learning management system and Studio. It uses open-source tools to aggregate and transform learning traces into data visualizations. +Aspects capture learning events and transform them into data visualizations. When a learner enrolls in a course, that event is caught in a database and displayed to the course delivery team as a graph of learner enrollments over time. When a course delivery team member adds a new problem to their course and publishes it, the course data is refreshed in the database to show how learners answer the question. -As of September 2023 it is in beta and seeking testers, which you can learn about at the `beta wiki page -`_. +Aspects are being built to help Open edX users answer questions like How many learners were active in a specified period? How often was this problem answered correctly vs. incorrectly? How much of each video did the users watch, and which sections were re-watched most? -Installation instructions are available on the plugin site: https://github.com/openedx/tutor-contrib-aspects +By default, Aspects prioritizes learner privacy and does not allow for the identification of learners in the reports. However, this functionality can be added via a tutor setting if desired. -You can get started reading about the project in the :ref:`aspects-overview`, or look through the various pages below for more details! +To learn more about working with Aspects in your instance, please review the following documentation, which has been meticulously crafted to be user-friendly and facilitate its utilization by educators, platform managers, and technical personnel. +To help you navigate the content, we divided it into the roles a person can have on Aspects. The roles for Aspects are: + +- `Administrator `_: This role owns the platform as the site operator, can assign roles and permissions to new users, and can create new reports. In this part of the documentation, you will find the operator dashboard and the permissions information. This user usually has the permissions of a Superuser in the platform. + +- `Course delivery team member `_: The course delivery team role applies to all course team members, such as content creators, tutors, and professors, who have been added as course staff. They have access to all the dashboards and reports for the courses for which they have been added as staff. Here, you will find information about the principal dashboards and reports, the filters, and the principal functions you need to know to use the analytics system. + +- `Technical Documentation `_: While developer is not a specific role that can be assigned to someone in Aspects, this third section contains all the technical documentation that any tech member needs to install Aspects and make it work, including the GitHub repositories and DBT and Clickhouse documentation. .. toctree:: :maxdepth: 2 - Concepts - Decisions - How-Tos - Quickstarts Reference + Course Delivery Team User + Administrator and Site Operator User + Technical Documentation -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/reference/course_overview_dashboard.rst b/docs/reference/course_overview_dashboard.rst new file mode 100644 index 0000000..375ce84 --- /dev/null +++ b/docs/reference/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/reference/index.rst b/docs/reference/index.rst index 90268a1..289b640 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -4,5 +4,8 @@ Reference Material .. toctree:: :maxdepth: 2 + course_overview_dashboard + individual_learner_dashboard + learner_groups_dashboard Instructor Reports Operator Reports diff --git a/docs/reference/individual_learner_dashboard.rst b/docs/reference/individual_learner_dashboard.rst new file mode 100644 index 0000000..4e502f7 --- /dev/null +++ b/docs/reference/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. \ No newline at end of file diff --git a/docs/reference/learner_groups_dashboard.rst b/docs/reference/learner_groups_dashboard.rst new file mode 100644 index 0000000..2a45a06 --- /dev/null +++ b/docs/reference/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. \ No newline at end of file diff --git a/docs/concepts/aspects_overview.rst b/docs/technical_documentation/concepts/aspects_overview.rst similarity index 100% rename from docs/concepts/aspects_overview.rst rename to docs/technical_documentation/concepts/aspects_overview.rst diff --git a/docs/concepts/authentication_permissions.rst b/docs/technical_documentation/concepts/authentication_permissions.rst similarity index 100% rename from docs/concepts/authentication_permissions.rst rename to docs/technical_documentation/concepts/authentication_permissions.rst diff --git a/docs/concepts/clickhouse.rst b/docs/technical_documentation/concepts/clickhouse.rst similarity index 100% rename from docs/concepts/clickhouse.rst rename to docs/technical_documentation/concepts/clickhouse.rst diff --git a/docs/concepts/data_lifecycle_policy.rst b/docs/technical_documentation/concepts/data_lifecycle_policy.rst similarity index 100% rename from docs/concepts/data_lifecycle_policy.rst rename to docs/technical_documentation/concepts/data_lifecycle_policy.rst diff --git a/docs/concepts/dbt.rst b/docs/technical_documentation/concepts/dbt.rst similarity index 100% rename from docs/concepts/dbt.rst rename to docs/technical_documentation/concepts/dbt.rst diff --git a/docs/concepts/extensions.rst b/docs/technical_documentation/concepts/extensions.rst similarity index 100% rename from docs/concepts/extensions.rst rename to docs/technical_documentation/concepts/extensions.rst diff --git a/docs/concepts/index.rst b/docs/technical_documentation/concepts/index.rst similarity index 100% rename from docs/concepts/index.rst rename to docs/technical_documentation/concepts/index.rst diff --git a/docs/concepts/pipelines.rst b/docs/technical_documentation/concepts/pipelines.rst similarity index 100% rename from docs/concepts/pipelines.rst rename to docs/technical_documentation/concepts/pipelines.rst diff --git a/docs/concepts/ralph.rst b/docs/technical_documentation/concepts/ralph.rst similarity index 100% rename from docs/concepts/ralph.rst rename to docs/technical_documentation/concepts/ralph.rst diff --git a/docs/concepts/superset.rst b/docs/technical_documentation/concepts/superset.rst similarity index 100% rename from docs/concepts/superset.rst rename to docs/technical_documentation/concepts/superset.rst diff --git a/docs/concepts/tracking_logs.rst b/docs/technical_documentation/concepts/tracking_logs.rst similarity index 100% rename from docs/concepts/tracking_logs.rst rename to docs/technical_documentation/concepts/tracking_logs.rst diff --git a/docs/concepts/vector.rst b/docs/technical_documentation/concepts/vector.rst similarity index 100% rename from docs/concepts/vector.rst rename to docs/technical_documentation/concepts/vector.rst diff --git a/docs/concepts/xapi_concepts.rst b/docs/technical_documentation/concepts/xapi_concepts.rst similarity index 100% rename from docs/concepts/xapi_concepts.rst rename to docs/technical_documentation/concepts/xapi_concepts.rst diff --git a/docs/decisions/0001-open-analytics.rst b/docs/technical_documentation/decisions/0001-open-analytics.rst similarity index 100% rename from docs/decisions/0001-open-analytics.rst rename to docs/technical_documentation/decisions/0001-open-analytics.rst diff --git a/docs/decisions/0002_xapi.rst b/docs/technical_documentation/decisions/0002_xapi.rst similarity index 100% rename from docs/decisions/0002_xapi.rst rename to docs/technical_documentation/decisions/0002_xapi.rst diff --git a/docs/decisions/0003_superset.rst b/docs/technical_documentation/decisions/0003_superset.rst similarity index 100% rename from docs/decisions/0003_superset.rst rename to docs/technical_documentation/decisions/0003_superset.rst diff --git a/docs/decisions/0004_clickhouse.rst b/docs/technical_documentation/decisions/0004_clickhouse.rst similarity index 100% rename from docs/decisions/0004_clickhouse.rst rename to docs/technical_documentation/decisions/0004_clickhouse.rst diff --git a/docs/decisions/0005_ralph.rst b/docs/technical_documentation/decisions/0005_ralph.rst similarity index 100% rename from docs/decisions/0005_ralph.rst rename to docs/technical_documentation/decisions/0005_ralph.rst diff --git a/docs/decisions/0006_areas_of_responsibility.rst b/docs/technical_documentation/decisions/0006_areas_of_responsibility.rst similarity index 100% rename from docs/decisions/0006_areas_of_responsibility.rst rename to docs/technical_documentation/decisions/0006_areas_of_responsibility.rst diff --git a/docs/decisions/0007_clickhouse_migrations.rst b/docs/technical_documentation/decisions/0007_clickhouse_migrations.rst similarity index 100% rename from docs/decisions/0007_clickhouse_migrations.rst rename to docs/technical_documentation/decisions/0007_clickhouse_migrations.rst diff --git a/docs/decisions/0008_project_structure.rst b/docs/technical_documentation/decisions/0008_project_structure.rst similarity index 100% rename from docs/decisions/0008_project_structure.rst rename to docs/technical_documentation/decisions/0008_project_structure.rst diff --git a/docs/decisions/0009_pii.rst b/docs/technical_documentation/decisions/0009_pii.rst similarity index 100% rename from docs/decisions/0009_pii.rst rename to docs/technical_documentation/decisions/0009_pii.rst diff --git a/docs/decisions/0010_localization.rst b/docs/technical_documentation/decisions/0010_localization.rst similarity index 100% rename from docs/decisions/0010_localization.rst rename to docs/technical_documentation/decisions/0010_localization.rst diff --git a/docs/decisions/0011_course_block_data.rst b/docs/technical_documentation/decisions/0011_course_block_data.rst similarity index 100% rename from docs/decisions/0011_course_block_data.rst rename to docs/technical_documentation/decisions/0011_course_block_data.rst diff --git a/docs/decisions/0012_clickhouse_dbt.rst b/docs/technical_documentation/decisions/0012_clickhouse_dbt.rst similarity index 100% rename from docs/decisions/0012_clickhouse_dbt.rst rename to docs/technical_documentation/decisions/0012_clickhouse_dbt.rst diff --git a/docs/decisions/0013_clickhouse_experimental.rst b/docs/technical_documentation/decisions/0013_clickhouse_experimental.rst similarity index 100% rename from docs/decisions/0013_clickhouse_experimental.rst rename to docs/technical_documentation/decisions/0013_clickhouse_experimental.rst diff --git a/docs/decisions/0014_dbt_state_default.rst b/docs/technical_documentation/decisions/0014_dbt_state_default.rst similarity index 100% rename from docs/decisions/0014_dbt_state_default.rst rename to docs/technical_documentation/decisions/0014_dbt_state_default.rst diff --git a/docs/decisions/index.rst b/docs/technical_documentation/decisions/index.rst similarity index 100% rename from docs/decisions/index.rst rename to docs/technical_documentation/decisions/index.rst diff --git a/docs/how-tos/backfill.rst b/docs/technical_documentation/how-tos/backfill.rst similarity index 100% rename from docs/how-tos/backfill.rst rename to docs/technical_documentation/how-tos/backfill.rst diff --git a/docs/how-tos/changing_actor_identifier.rst b/docs/technical_documentation/how-tos/changing_actor_identifier.rst similarity index 100% rename from docs/how-tos/changing_actor_identifier.rst rename to docs/technical_documentation/how-tos/changing_actor_identifier.rst diff --git a/docs/how-tos/clickhouse_cluster.rst b/docs/technical_documentation/how-tos/clickhouse_cluster.rst similarity index 100% rename from docs/how-tos/clickhouse_cluster.rst rename to docs/technical_documentation/how-tos/clickhouse_cluster.rst diff --git a/docs/how-tos/clickhouse_sql.rst b/docs/technical_documentation/how-tos/clickhouse_sql.rst similarity index 100% rename from docs/how-tos/clickhouse_sql.rst rename to docs/technical_documentation/how-tos/clickhouse_sql.rst diff --git a/docs/how-tos/dbt_extensions.rst b/docs/technical_documentation/how-tos/dbt_extensions.rst similarity index 100% rename from docs/how-tos/dbt_extensions.rst rename to docs/technical_documentation/how-tos/dbt_extensions.rst diff --git a/docs/how-tos/index.rst b/docs/technical_documentation/how-tos/index.rst similarity index 94% rename from docs/how-tos/index.rst rename to docs/technical_documentation/how-tos/index.rst index b771b19..0bcaae5 100644 --- a/docs/how-tos/index.rst +++ b/docs/technical_documentation/how-tos/index.rst @@ -5,6 +5,7 @@ How-Tos :maxdepth: 2 :caption: Content: + Aspects Plugin for Tutor Upgrade Aspects Configure Aspects for Production Changing the xAPI actor identifier diff --git a/docs/technical_documentation/how-tos/install_aspects.rst b/docs/technical_documentation/how-tos/install_aspects.rst new file mode 100644 index 0000000..9ebafa2 --- /dev/null +++ b/docs/technical_documentation/how-tos/install_aspects.rst @@ -0,0 +1,9 @@ +Aspects Plugin for Tutor +************************ + +Aspects is implemented as a Tutor plugin. To learn more about how to install it, please refer to the plugin GitHub site: +``_ + +Rest assured, this plugin is fully compatible with Tutor 15.0.0 and later, and is expected to seamlessly integrate with Open edX releases from Nutmeg onwards. + +To have more information about the plugin, visit ``_ diff --git a/docs/how-tos/production_configuration.rst b/docs/technical_documentation/how-tos/production_configuration.rst similarity index 100% rename from docs/how-tos/production_configuration.rst rename to docs/technical_documentation/how-tos/production_configuration.rst diff --git a/docs/how-tos/remote_clickhouse.rst b/docs/technical_documentation/how-tos/remote_clickhouse.rst similarity index 100% rename from docs/how-tos/remote_clickhouse.rst rename to docs/technical_documentation/how-tos/remote_clickhouse.rst diff --git a/docs/how-tos/superset_extra_assets.rst b/docs/technical_documentation/how-tos/superset_extra_assets.rst similarity index 100% rename from docs/how-tos/superset_extra_assets.rst rename to docs/technical_documentation/how-tos/superset_extra_assets.rst diff --git a/docs/how-tos/superset_jinja_filters.rst b/docs/technical_documentation/how-tos/superset_jinja_filters.rst similarity index 100% rename from docs/how-tos/superset_jinja_filters.rst rename to docs/technical_documentation/how-tos/superset_jinja_filters.rst diff --git a/docs/how-tos/superset_language_settings.rst b/docs/technical_documentation/how-tos/superset_language_settings.rst similarity index 100% rename from docs/how-tos/superset_language_settings.rst rename to docs/technical_documentation/how-tos/superset_language_settings.rst diff --git a/docs/how-tos/superset_roles.rst b/docs/technical_documentation/how-tos/superset_roles.rst similarity index 100% rename from docs/how-tos/superset_roles.rst rename to docs/technical_documentation/how-tos/superset_roles.rst diff --git a/docs/how-tos/superset_row_level_security.rst b/docs/technical_documentation/how-tos/superset_row_level_security.rst similarity index 100% rename from docs/how-tos/superset_row_level_security.rst rename to docs/technical_documentation/how-tos/superset_row_level_security.rst diff --git a/docs/how-tos/upgrade.rst b/docs/technical_documentation/how-tos/upgrade.rst similarity index 100% rename from docs/how-tos/upgrade.rst rename to docs/technical_documentation/how-tos/upgrade.rst diff --git a/docs/how-tos/xapi_transforms.rst b/docs/technical_documentation/how-tos/xapi_transforms.rst similarity index 100% rename from docs/how-tos/xapi_transforms.rst rename to docs/technical_documentation/how-tos/xapi_transforms.rst diff --git a/docs/technical_documentation/index.rst b/docs/technical_documentation/index.rst new file mode 100644 index 0000000..b3ffc23 --- /dev/null +++ b/docs/technical_documentation/index.rst @@ -0,0 +1,23 @@ +Technical Documentation +============================================== + +Aspects is an analytics system for Open edX, bringing actionable data about course and learner performance to instructors and site operators. It is primarily a Tutor plugin that ties together data from the Open edX learning management system and Studio using open source tools to aggregate and transform learning traces into data visualizations. + +As of September 2023 it is in beta and seeking testers, which you can learn about at the `beta wiki page +`_. + +Installation instructions are available on the plugin site: https://github.com/openedx/tutor-contrib-aspects + +You can get started reading about the project in the :ref:`aspects-overview`, or look through the various pages below for more details! + + +.. toctree:: + :maxdepth: 2 + + Concepts + How-To's + Quickstarts + Decisions + + + diff --git a/docs/quickstarts/index.rst b/docs/technical_documentation/quickstarts/index.rst similarity index 100% rename from docs/quickstarts/index.rst rename to docs/technical_documentation/quickstarts/index.rst diff --git a/docs/quickstarts/ralph.rst b/docs/technical_documentation/quickstarts/ralph.rst similarity index 100% rename from docs/quickstarts/ralph.rst rename to docs/technical_documentation/quickstarts/ralph.rst diff --git a/docs/quickstarts/vector.rst b/docs/technical_documentation/quickstarts/vector.rst similarity index 100% rename from docs/quickstarts/vector.rst rename to docs/technical_documentation/quickstarts/vector.rst