From 1a96eee32a2f92120e081b66203d1050ebe8c2f2 Mon Sep 17 00:00:00 2001
From: Dominik George <dominik.george@teckids.org>
Date: Thu, 13 Jan 2022 21:31:12 +0100
Subject: [PATCH] [Docs] Add references
---
docs/admin/10_features.rst | 4 +++-
docs/admin/20_configuration.rst | 19 +++++++++++--------
docs/conf.py | 2 ++
3 files changed, 16 insertions(+), 9 deletions(-)
diff --git a/docs/admin/10_features.rst b/docs/admin/10_features.rst
index 051a490..0674261 100644
--- a/docs/admin/10_features.rst
+++ b/docs/admin/10_features.rst
@@ -7,7 +7,7 @@ functionality to automatically import data from Untis into data models
of the core and `Chronos`, the timetable and substitution app of AlekSIS.
Currently, we only support importing data from the MySQL database of
-`Untis MultiUser`. This is done through configurable background tasks
+`Untis MultiUser`_. This is done through configurable background tasks
which are executed in a specific interval or at specific points in time.
Supported Untis features
@@ -34,3 +34,5 @@ Currently, the following features are known not to be supported:
* Prebookings
* Statistical data
* Special rooms (subject and group rooms)
+
+.. _Untis MultiUser: https://www.untis.at/produkte/untis-das-grundpaket/multiuser
diff --git a/docs/admin/20_configuration.rst b/docs/admin/20_configuration.rst
index be9cf3e..1fedb6f 100644
--- a/docs/admin/20_configuration.rst
+++ b/docs/admin/20_configuration.rst
@@ -9,14 +9,14 @@ license (version 2019 and above) and a MySQL database which
is reachable by the AlekSIS server. How to configure Untis
to use this database is described in the `Untis MultiUser Manual`_.
-In addition to the technical requirements of AlekSIS itself,
-a few extra system packages are required:
+In addition to the technical :ref:`core-install-prerequisites` of
+the AlekSIS core itself, a few extra system packages are required:
.. code-block:: shell
apt install libmariadb-dev
-The MySQL (or MariaDB) server must be reachable from the AlekSIS
+The MySQL (or `MariaDB`_) server must be reachable from the AlekSIS
server, and a user account in the database is needed. It is sufficient
to create this user with ``SELECT`` permissions. On the MySQL shell,
you can create such a user with something like:
@@ -32,7 +32,8 @@ you can create such a user with something like:
Configure database connection
-----------------------------
-In the AlekSIS configuration file, you have to set following settings:
+In the AlekSIS configuration file (cf. :ref:`core-configuraiton-files`,
+you have to set the following settings:
.. code-block:: toml
@@ -72,7 +73,7 @@ The way data are imported can be configured from the menu under
Scheduling import tasks
-----------------------
-The integration provides different background tasks to import the data from Untis:
+The integration provides different :ref:`core-periodic-tasks` to import the data from Untis:
* ``untis_import_mysql_current_term``: This will import all data from the **current**
Untis term.
@@ -98,8 +99,10 @@ How existing data is matched
If there are already existing data in AlekSIS' database, the Untis import will
always try to combine these data. The main data field used for this is the
-``short name`` field. If the data were imported one time, each object in
-Chronos will save the respective ID from Untis to make sure that the data are
-properly updated at the next import.
+``short name`` field (cf. :ref:`core-concept-group`. If the data were imported
+one time, each object in Chronos will save the respective ID from Untis to make
+sure that the data are properly updated at the next import.
The import is thus idempotent.
+
+.. _MariaDB: https://mariadb.org
diff --git a/docs/conf.py b/docs/conf.py
index 4bb4608..c7b1f57 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -204,4 +204,6 @@ epub_exclude_files = ["search.html"]
intersphinx_mapping = {
"https://docs.python.org/": None,
"https://docs.djangoproject.com/en/stable": "https://docs.djangoproject.com/en/stable/_objects",
+ "https://aleksis.edugit.io/AlekSIS-Core/docs": None,
+ "https://aleksis.edugit.io/AlekSIS-App-Chronos/docs": None,
}
--
GitLab