docs: fix broken links (#232)

openedx · Jul 1, 2024 · b2d1712 · b2d1712
1 parent 4ae3989
commit b2d1712
Show file tree

Hide file tree

Showing 17 changed files with 15 additions and 12 deletions.
diff --git a/docs/administator/concepts/index.rst → docs/administrator/concepts/index.rst b/docs/administator/concepts/index.rst → docs/administrator/concepts/index.rst
diff --git a/docs/administator/concepts/permissions.rst → docs/administrator/concepts/permissions.rst b/docs/administator/concepts/permissions.rst → docs/administrator/concepts/permissions.rst
@@ -9,4 +9,4 @@ 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 <superset_roles>`_.
+To learn more about this topic, review the `technical documentation <https://docs.openedx.org/projects/openedx-aspects/en/latest/technical_documentation/how-tos/superset_roles.html>`_.
diff --git a/...dministator/concepts/role_description.rst → ...ministrator/concepts/role_description.rst b/...dministator/concepts/role_description.rst → ...ministrator/concepts/role_description.rst
@@ -24,4 +24,6 @@ Here's a breakdown of their key responsibilities:
 - **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.
+Site Operators act as Superset's system administrators, granting access, ensuring data security, and overseeing the platform's overall functionality.
+
+.. seealso:: It may be important to review `technical documentation <https://docs.openedx.org/projects/openedx-aspects/en/latest/technical_documentation/index.html>`_ to delve into database and platform configuration issues for this role.
diff --git a/docs/administator/how_to/activity_logs.rst → docs/administrator/how_to/activity_logs.rst b/docs/administator/how_to/activity_logs.rst → docs/administrator/how_to/activity_logs.rst
diff --git a/...dministator/how_to/alerts_and_reports.rst → ...ministrator/how_to/alerts_and_reports.rst b/...dministator/how_to/alerts_and_reports.rst → ...ministrator/how_to/alerts_and_reports.rst
@@ -3,7 +3,7 @@ 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 <access_aspects>`_ to refresh your knowledge of this process.
+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 <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/access_aspects.html>`_ to refresh your knowledge of this process.
 
 2. Log in to Superset with your administrator credentials.
 

diff --git a/docs/administator/how_to/create_new_role.rst → .../administrator/how_to/create_new_role.rst b/docs/administator/how_to/create_new_role.rst → .../administrator/how_to/create_new_role.rst
@@ -1,7 +1,7 @@
 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 <access_aspects>`_ to refresh your knowledge of this process.
+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 <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/access_aspects.html>`_ to refresh your knowledge of this process.
 
 2. Log in to Superset with your administrator credentials.
 

diff --git a/...inistator/how_to/database_connections.rst → ...nistrator/how_to/database_connections.rst b/...inistator/how_to/database_connections.rst → ...nistrator/how_to/database_connections.rst
@@ -3,7 +3,7 @@ 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 <access_aspects>`_ to refresh your knowledge of this process.
+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 <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/access_aspects.html>`_ to refresh your knowledge of this process.
 
 2. Log in to Superset with your administrator credentials.
 

diff --git a/...ministator/how_to/export_tabular_data.rst → ...inistrator/how_to/export_tabular_data.rst b/...ministator/how_to/export_tabular_data.rst → ...inistrator/how_to/export_tabular_data.rst
@@ -15,4 +15,4 @@ You can download data from Superset in different formats, but probably the most
 
 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 <download_reports>`_.
+.. seealso:: To learn how to export information as a PDF or as an image, visit `How to Downloading Reports in Superset Dashboards <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/download_reports.html>`_.
diff --git a/docs/administator/how_to/index.rst → docs/administrator/how_to/index.rst b/docs/administator/how_to/index.rst → docs/administrator/how_to/index.rst
diff --git a/docs/administator/how_to/view_data.rst → docs/administrator/how_to/view_data.rst b/docs/administator/how_to/view_data.rst → docs/administrator/how_to/view_data.rst
diff --git a/docs/administator/index.rst → docs/administrator/index.rst b/docs/administator/index.rst → docs/administrator/index.rst
diff --git a/docs/administator/reference/index.rst → docs/administrator/reference/index.rst b/docs/administator/reference/index.rst → docs/administrator/reference/index.rst
diff --git a/docs/course_team/how-tos/access_aspects.rst b/docs/course_team/how-tos/access_aspects.rst
@@ -9,7 +9,7 @@ Once the Administrator has assigned you the course delivery team role and permit
 
 .. image:: /_static/reports_tab.png
 
-There you will see the three principal dashboards of Aspects: the `Course Dashboard <course_overview_dashboard>`_, the `Individual Learner Dashboard <individual_learner_dashboard>`_, and the `At Risk Learner Dashboard <learner_groups_dashboard>`_. From these dashboards, you will see the course and learner information that Aspects has collected.
+There you will see the three principal dashboards of Aspects: the `Course Dashboard <https://docs.openedx.org/projects/openedx-aspects/en/latest/reference/course_overview_dashboard.html>`_, the `Individual Learner Dashboard <https://docs.openedx.org/projects/openedx-aspects/en/latest/reference/individual_learner_dashboard.html>`_, and the `At Risk Learner Dashboard <https://docs.openedx.org/projects/openedx-aspects/en/latest/reference/learner_groups_dashboard.html>`_. 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.

diff --git a/docs/index.rst b/docs/index.rst
@@ -23,7 +23,7 @@ To help you navigate the content, we divided it into the roles a person can have
 
    Reference <reference/index>
    Course Delivery Team User <course_team/index>
-   Administrator and Site Operator User <administator/index>
+   Administrator and Site Operator User <administrator/index>
    Technical Documentation <technical_documentation/index>
 
 

diff --git a/docs/reference/course_overview_dashboard.rst b/docs/reference/course_overview_dashboard.rst
@@ -35,6 +35,7 @@ These metrics give you information about users' engagement with the course and i
 Performance Metrics:
 ====================
 These metrics show the learners' performance in the course according to their grades and the approval percentage.
+
 .. image:: /_static/performance_metrics.png
 
 

diff --git a/docs/technical_documentation/concepts/ralph.rst b/docs/technical_documentation/concepts/ralph.rst
@@ -12,7 +12,7 @@ Although Ralph has usages such as:
 - Convert tracking logs to xAPI statements.
 - Fetch xAPI statements from a configured backend.
 - Validate xAPI statements.
-- Store events to different `backends <https://openfun.github.io/ralph/backends/>`_.
+- Store events to different backends `backends <https://openfun.github.io/ralph/latest/features/backends/>`_.
 
 In the aspects project, Ralph is optionally used as the API server that connects Open edX
 and Clickhouse database. Ralph receives the xAPI statements from Open edX and stores them

diff --git a/docs/technical_documentation/concepts/vector.rst b/docs/technical_documentation/concepts/vector.rst
@@ -15,11 +15,11 @@ Vector Components
 
 Vector consists of the following components:
 
-- `Sources <https://vector.dev/docs/reference/sources/>`_ - Collects data from a source
+- `Sources <https://vector.dev/docs/reference/configuration/sources/>`_ - Collects data from a source
   and sends it to Vector.
-- `Transforms <https://vector.dev/docs/reference/transforms/>`_ - Modifies events as they
+- `Transforms <https://vector.dev/docs/reference/configuration/transforms//>`_ - Modifies events as they
   pass through Vector.
-- `Sinks <https://vector.dev/docs/reference/sinks/>`_ - Sends events to a destination.
+- `Sinks <https://vector.dev/docs/reference/configuration/sinks/>`_ - Sends events to a destination.
 
 Vector can be deployed in two roles:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,4 +15,4 @@ You can download data from Superset in different formats, but probably the most

		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 <download_reports>`_.
		.. seealso:: To learn how to export information as a PDF or as an image, visit `How to Downloading Reports in Superset Dashboards <https://docs.openedx.org/projects/openedx-aspects/en/latest/course_team/how-tos/download_reports.html>`_.