mirror of
https://framagit.org/framasoft/framaspace/argos.git
synced 2025-04-28 18:02:41 +02:00
Change mermaid class diagrams
This commit is contained in:
parent
336c4e783b
commit
0adb5e2766
4 changed files with 27 additions and 57 deletions
BIN
docs/capture.png
BIN
docs/capture.png
Binary file not shown.
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 300 KiB |
|
@ -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
|
||||
```
|
||||
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||

|
||||
## 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 ?.
|
||||
:::
|
||||
::::
|
||||
|
|
|
@ -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
|
Loading…
Reference in a new issue