Skip to content

Commit

Permalink
Update service dependencies descriptions in docs
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
jmborr committed Sep 5, 2024
1 parent 51a6e78 commit 0ad3360
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/developer/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 16 additions & 0 deletions docs/developer/instruction/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,22 @@ Developing in a Local Environment
.. note::
This document is updated, however, it may be good to read the `continuous integration <https://github.com/neutrons/data_workflow/tree/next/.github/workflows>`_ 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,
Expand Down

0 comments on commit 0ad3360

Please sign in to comment.