diff --git a/docs/client-development/index.rst b/docs/client-development/index.rst index 2b391db..3615fd2 100644 --- a/docs/client-development/index.rst +++ b/docs/client-development/index.rst @@ -1,7 +1,7 @@ .. _client-development: Open Producten client documentation -============================== +=================================== Open Producten is primarily a provider of API's to be consumed by clients. If you're developing such a client (or consumer), you're in the right place! diff --git a/docs/development/getting_started.rst b/docs/development/getting_started.rst index 957b43f..b911a4e 100644 --- a/docs/development/getting_started.rst +++ b/docs/development/getting_started.rst @@ -157,6 +157,7 @@ The file ``includes/local.py`` overwrites settings from the base configuration, and is only loaded for the dev settings. .. TODO: remove Celery part below? No references for usage found in project + Running background tasks ===================================== diff --git a/docs/development/releasing.rst b/docs/development/releasing.rst index 6894e77..7c14da8 100644 --- a/docs/development/releasing.rst +++ b/docs/development/releasing.rst @@ -65,3 +65,5 @@ Once the PR is merged to main, check out the ``master`` branch and tag it: git tag 1.0.0 Tagging will ensure that a Docker image ``maykinmedia/open-producten:1.0.0`` is published. + +. _`Maykin`: https://github.com/maykinmedia diff --git a/docs/development/security.rst b/docs/development/security.rst index 7655e12..85bbba9 100644 --- a/docs/development/security.rst +++ b/docs/development/security.rst @@ -1,5 +1,5 @@ Security measures in Open Producten -============================== +=================================== The following is a non-exhaustive list of configurations in Open Producten to enhance security. @@ -24,7 +24,7 @@ are set in the virtual host: there's no need for these :-) Open Producten settings ------------------- +----------------------- ``X-Frame-Options`` is set to ``DENY`` no (i)frames are allowed at all diff --git a/docs/index.rst b/docs/index.rst index 59f0dab..dee3e52 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ Open Producten Documentation -======================= +============================ **Open Producten** is an application where product types and products can be managed in a single place. Other applications like `Open Inwoner`_ and `Open diff --git a/docs/installation/config/openproducten_config.rst b/docs/installation/config/openproducten_config.rst index 5327182..efdb309 100644 --- a/docs/installation/config/openproducten_config.rst +++ b/docs/installation/config/openproducten_config.rst @@ -1,8 +1,8 @@ .. _installation_configuration: -=============================== +==================================== Open Producten configuration (admin) -=============================== +==================================== Before you can work with Open Producten after installation, a few settings need to be configured first. @@ -29,7 +29,7 @@ Create an API token =================== Open Producten ---------- +-------------- By creating an API token, we can perform an API test call to verify the successful installation. @@ -47,7 +47,7 @@ Making an API call ================== Open Producten ---------- +-------------- We can now make an HTTP request to one of the APIs of Open Producten. For this example, we have used `curl`_ to make the request. diff --git a/docs/installation/reference/time.rst b/docs/installation/reference/time.rst index d4c1473..5413154 100644 --- a/docs/installation/reference/time.rst +++ b/docs/installation/reference/time.rst @@ -16,7 +16,7 @@ possible, both client and server should use the *same* services so that their cl in sync. Where Open Producten deals with time-aspects -======================================= +============================================ Open Producten deals with time-based validations in a number of places, of which you can configure how Open Producten deals with them for a subset of these places. diff --git a/docs/installation/updating.rst b/docs/installation/updating.rst index d3ca3b3..c8e8c41 100644 --- a/docs/installation/updating.rst +++ b/docs/installation/updating.rst @@ -1,7 +1,7 @@ .. _installation_updating: Updating an Open Producten installation -================================== +======================================= Software receives new features and bugfixes all the time, and Open Producten is no different. At some point, you'll want to update to a newer version of Open Producten - be it a patch diff --git a/docs/introduction/open-source/index.rst b/docs/introduction/open-source/index.rst index 33a00e6..bff3a92 100644 --- a/docs/introduction/open-source/index.rst +++ b/docs/introduction/open-source/index.rst @@ -8,6 +8,9 @@ Open Producten is open-source and available under the `EUPL license`_. In addition, this project makes use of various open-source `Python libraries`_ under the hood. +.. _`EUPL license`: https://github.com/maykinmedia/open-producten/blob/master/LICENSE.md +.. _`Python libraries`: https://github.com/maykinmedia/open-producten/blob/master/requirements/base.txt + .. toctree:: :maxdepth: 1 diff --git a/docs/introduction/team.rst b/docs/introduction/team.rst index 2ee1b9a..f6235d0 100644 --- a/docs/introduction/team.rst +++ b/docs/introduction/team.rst @@ -1,5 +1,5 @@ Who's behind Open Producten? -======================= +============================ .. TODO: diff --git a/docs/manual/oidc.rst b/docs/manual/oidc.rst index 47bee25..31a8b0f 100644 --- a/docs/manual/oidc.rst +++ b/docs/manual/oidc.rst @@ -39,7 +39,7 @@ Aan het eind van dit proces moet je de volgende gegevens hebben (on premise): * Client secret, bijvoorbeeld ``97d663a9-3624-4930-90c7-2b90635bd990`` Configureren van OIDC in Open Producten -================================== +======================================= Zorg dat je de volgende :ref:`gegevens ` hebt: