diff --git a/docs/capture.png b/docs/capture.png index 81a8071..5a65fcd 100644 Binary files a/docs/capture.png and b/docs/capture.png differ diff --git a/docs/developer/models.md b/docs/developer/models.md index 8199130..79bc219 100644 --- a/docs/developer/models.md +++ b/docs/developer/models.md @@ -3,26 +3,28 @@ ```{mermaid} classDiagram direction RL -Task *-- Result : Have many -Task: id -Task: url -Task: domain -Task: check -Task: expected -Task: frequency -Task: selected_by -Task: selected_at -Task: completed_at -Task: next_run - -Result: id -Result: task_id -Result: task -Result: agent_id -Result: submitted_at -Result: status -Result: severity -Result: context +class Task { + - url + - domain + - check + - expected + - frequency + - selected_by + - selected_at + - completed_at + - next_run +} +class Result{ + - task : Task + - task_id + - task + - agent_id + - submitted_at + - status + - severity + - context +} +Result "*" o-- "1" Task : has many ``` diff --git a/docs/index.md b/docs/index.md index 5c76054..bd7672c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Argos +# Argos monitoring Argos is an HTTP monitoring service. @@ -15,6 +15,9 @@ Internally, a HTTP API is exposed, and a job queue is used to distribute the che - **Extensible**: You can add new checks using pure python. - **HTTP API**: You can use the HTTP API to get the results of the checks. +![Argos architecture](capture.png) +## Installation + ```{code-block} bash pip install argos-monitoring argos server run @@ -35,7 +38,7 @@ caption: config.yaml The best way to get started with argos. ::: :::{grid-item-card} Developper docs -:link: /developper +:link: /developer/overview.html You want to know more about the internals ?. ::: :::: diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 32bb245..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=. -set BUILDDIR=_build - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd