From 0ad3360f8ba35dae8c1446f37fb773cd1816f044 Mon Sep 17 00:00:00 2001 From: Jose Borreguero Date: Thu, 5 Sep 2024 15:49:01 -0400 Subject: [PATCH] Update service dependencies descriptions in docs Clarify dependency relationships and add a diagram in build.rst. This ensures a clear understanding of service dependencies for local deployment, aiding both unit and system tests. Signed-off-by: Jose Borreguero --- docs/developer/index.rst | 5 ++--- docs/developer/instruction/build.rst | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/developer/index.rst b/docs/developer/index.rst index 6c4df98f..b75af0cd 100644 --- a/docs/developer/index.rst +++ b/docs/developer/index.rst @@ -41,9 +41,8 @@ Services -------- The components making up the infrastructure of Web Monitor have dependencies. -In the diagram below shows the dependencies of the local deployment. -`service1` --> `service2` is to be read as `service1` depends on `service2`. -For instance, `webmonchow` depends on `db`. +In the diagram below shows the dependencies of the local deployment, +where service ``webmonchow`` depends on service ``db``. .. image:: images/local_deployment_dependence_graph.png :width: 600px diff --git a/docs/developer/instruction/build.rst b/docs/developer/instruction/build.rst index 0b6e0f31..6c11f524 100644 --- a/docs/developer/instruction/build.rst +++ b/docs/developer/instruction/build.rst @@ -7,6 +7,22 @@ Developing in a Local Environment .. note:: This document is updated, however, it may be good to read the `continuous integration `_ scripts as well. +Dependencies between services +----------------------------- + +The services making up the infrastructure of Web Monitor have dependencies. +The diagram below shows the dependencies for a local deployment guaranteeing that +the application will run _and_ that both unit and system tests will pass. + +``service1`` --> ``service2`` is to be read as ``service1`` depends on ``service2``. +For instance, ``webmonchow`` depends on ``db``. + +.. image:: ../images/local_deployment_dependence_graph.png + :width: 600px + :align: center + :alt: services dependence graph + + Description of available Django settings ---------------------------------------- Settings are split according to different target environments,