fix: use proper title and subtitle

openedx · Jul 26, 2023 · c4b7b8a · c4b7b8a
1 parent b3f6386
commit c4b7b8a
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 32 deletions.
diff --git a/docs/concepts/authentication_permissions.rst b/docs/concepts/authentication_permissions.rst
@@ -1,7 +1,7 @@
 .. _authentication-permissions:
 
 Authentication and Permissions
-######################################
+******************************
 
 Users access Aspects data and reports by signing into Superset, which will confirm their identity
 and permissions with the LMS. This is done using Single Sign On (SSO) and JSON Web Tokens (JWT).
@@ -29,13 +29,13 @@ Roles can be extended and assigned using a combination of extensions described i
 :ref:`extensions` docs.
 
 Superset Authentication
------------------------
+#######################
 
 Superset authentication is performed against the LMS using SSO. In this process, the LMS provides
 a JWT token that's later used to perform API calls to find out the user's roles and permissions.
 
 Superset Permissions
------------------------
+####################
 
 Permissions are assigned to roles and are used to control access to specific resources
 such as dashboards, tables, menus, etc.
@@ -45,7 +45,7 @@ can only be accessed by users with the role assigned to it.
 
 
 Superset Row Level Security Filters
------------------------------------
+###################################
 
 Row level security filters (RLSF) are used to control access to specific data. For example,
 an instructor should only be able to see data for the courses they are teaching.

diff --git a/docs/concepts/clickhouse.rst b/docs/concepts/clickhouse.rst
@@ -1,5 +1,5 @@
 Clickhouse
-##################################
+****************************
 
 ClickHouse is a high-performance, column-oriented SQL database management system (DBMS) 
 for online analytical processing (OLAP). It is used as the backend storage for the Aspects 
@@ -10,13 +10,14 @@ Aspects is compatible with Clickhouse Cloud and on premise Clickhouse instances.
 See :ref:`remote-clickhouse` for more information.
 
 Clickhouse Migrations
-****************************
+##################################
+
 
 Clickhouse migrations are handled by `Alembic <https://alembic.sqlalchemy.org/en/latest/>`_.
 To learn more about `Alembic`_ and how to use it, please refer to the ADR :ref:`clickhouse-migrations`.
 
 Clickhouse Structure
-************************
+##################################
 
 Clickhouse is used to store the data ingested by the Aspects project via Ralph or Vector. The data is stored
 in a single database controlled by the variable **ASPECTS_XAPI_DATABASE**, and a single table controlled by

diff --git a/docs/concepts/extensions.rst b/docs/concepts/extensions.rst
@@ -1,29 +1,29 @@
 .. _extensions:
 
 Aspects Extensions
-#####################
+******************
 
 Aspects is a project that comes with a set of extensions that can be used to
 extend the different parts of the project.
 
 Superset Assets
-================
+###############
 
 Aspects allows the site operator to programatically define custom Superset assets, such as 
 Databases, Datases, Slices or Dashboard, and override default ones.
 
 See :ref:`superset-extra-assets` for more information.
 
 Superset Language
-===================================
+#################
 
 Superset localization is a work in progress, but you can change the default language and
 set alternate languages from the currently supported list.
 
 See :ref:`superset-language-settings` for more information.
 
 Superset Custom Row Level Security Filters
-=============================================
+##########################################
 
 If you add new Databases, tables, or Datasets to Superset, you may want to add new
 row level security filters to restrict access to the data based on things like user
@@ -32,7 +32,7 @@ roles, or organization.
 See :ref:`superset-row-level-security` for more information.
 
 Superset Custom Jinja Filters
-=============================
+#############################
 
 Aspects allows the site operator to add custom jinja filters to Superset which can be used to generate SQL
 statements based on the current user role or any given input.
@@ -42,22 +42,22 @@ In Aspects, those are used to filter the data based on the user course access.
 See :ref:`superset-jinja-filters` for more information.
 
 Superset Custom Roles
-=====================
+#####################
 
 Aspects allows the site operator to add custom Superset roles which can be seen as groups of permissions,
 those are automatically associated at login. 
 
 See :ref:`superset-roles` for more information.
 
 Custom Clickhouse SQL
-=====================
+#####################
 
 Aspects allows the site operator to add custom Clickhouse SQL at initialization. 
 
 See :ref:`clickhouse-sql` for more information.
 
 Extending DBT
-=============
+#############
 
 You can extend the DBT project to install additional packages, and modify the base DBT
 models which are used by the reports.

diff --git a/docs/concepts/ralph.rst b/docs/concepts/ralph.rst
@@ -1,5 +1,5 @@
 Ralph
-#############
+*****
 
 Ralph is a toolbox for Open edX learning analytics. It can be used as a library,
 command line interface, or as an API server.

diff --git a/docs/concepts/superset.rst b/docs/concepts/superset.rst
@@ -1,5 +1,5 @@
 Superset
-#############
+********
 
 Apache Superset is a modern, enterprise-ready business intelligence web application.
 It is fast, lightweight, intuitive, and loaded with options that make it easy for users
@@ -11,7 +11,7 @@ is performed against the LMS using SSO. You can find more information in
 :ref:`authentication-permissions`.
 
 Superset Concepts
------------------
+#################
 
 Superset is composed of several main concepts:
 

diff --git a/docs/concepts/vector.rst b/docs/concepts/vector.rst
@@ -1,15 +1,15 @@
 Vector
-##################################
+******
 
 Vector is lightweight and ultra-fast tool for building observability pipelines.
 In the Aspects project, Vector can optionally be used as a replacement for Ralph to
 capture xAPI learner statements in the ClickHouse database, and/or as a way to
 store raw tracking log statements. It can be used as a general purpose log collector
-and forwarder
+and forwarder.
 
 
 Vector Components
------------------
+#################
 
 Vector consists of the following components:
 

diff --git a/docs/concepts/xapi_concepts.rst b/docs/concepts/xapi_concepts.rst
@@ -1,8 +1,9 @@
 xAPI Concepts
-#############
+*************
 
 Introduction
-------------
+###################
+
 xAPI, also known as the Experience API or Tin Can API, is a specification for capturing 
 and tracking learning experiences in a wide range of contexts. It is an e-learning 
 standard that allows organizations to gather data about learner activities and interactions
@@ -11,7 +12,8 @@ framework for collecting, storing, and analyzing learning data, enabling a deepe
 understanding of learners' experiences and performance.
 
 Components of xAPI
-------------------
+###################
+
 The xAPI specification consists of three key components:
 
 .. _actor_concept:

diff --git a/docs/how-tos/clickhouse_sql.rst b/docs/how-tos/clickhouse_sql.rst
@@ -1,7 +1,7 @@
 .. _clickhouse-sql:
 
 Clickhouse extra SQL
-###################################
+********************
 
 You can execute extra Clickhouse SQL at initialization. To do so, you need to use the
 patch `clickhouse-extra-sql`. This patch expects valid Clickhouse SQL code:

diff --git a/docs/how-tos/dbt_extensions.rst b/docs/how-tos/dbt_extensions.rst
@@ -1,7 +1,7 @@
 .. _dbt-extensions:
 
 DBT extensions
-#####################
+**************
 
 To extend the DBT project, you can use the following Tutor variables:
 

diff --git a/docs/how-tos/superset_extra_assets.rst b/docs/how-tos/superset_extra_assets.rst
@@ -1,7 +1,7 @@
 .. _superset-extra-assets:
 
 Superset extra assets
-#####################
+*********************
 
 Developers the patch `superset-extra-assets` to add extra assets to Superset and those
 will be imported at initialization.
@@ -38,7 +38,7 @@ Additionally to the default fields for each asset type, the following fields are
 - Dashboard: **_roles** a list of roles names to be associated with a dashboard.
 
 Override Superset Default Assets
-================================
+################################
 
 Aspects allows the site operator to override the default Superset assets by creating an Superset
 extra asset as explained above using the same UUID as the default asset. The UUID of the default

diff --git a/docs/how-tos/superset_jinja_filters.rst b/docs/how-tos/superset_jinja_filters.rst
@@ -1,7 +1,7 @@
 .. _superset-jinja-filters:
 
 Superset extra jinja filters
-############################
+*****************************
 
 
 To create extra jinja filters, you can use the patch `superset-jinja-filters`

diff --git a/docs/how-tos/superset_language_settings.rst b/docs/how-tos/superset_language_settings.rst
@@ -1,7 +1,7 @@
 .. _superset-language-settings:
 
 Superset language settings
-###################################
+**************************
 
 By changing the following Tutor configuration variables you can change the default
 language:

diff --git a/docs/how-tos/superset_roles.rst b/docs/how-tos/superset_roles.rst
@@ -1,7 +1,7 @@
 .. _superset-roles:
 
 Superset extra roles
-###################################
+*********************
 
 Create extra Superset roles, you can use the patch `superset-extra-roles`. This patch
 expects validJSON objects with the following structure:

diff --git a/docs/how-tos/superset_row_level_security.rst b/docs/how-tos/superset_row_level_security.rst
@@ -1,7 +1,7 @@
 .. _superset-row-level-security:
 
 Superset extra row level security
-#################################
+*********************************
 
 To apply custom row level security filters to Superset, you can use the patch 
 `superset-row-level-security`. This patch expects a list of python dictionaries