From d6b53bed91ef2107946f74d5ed8b762c087ace3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= Date: Sat, 16 Dec 2023 20:46:01 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20enhance=20project=20list?= =?UTF-8?q?=20with=20descriptions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/developer/projects.md | 20 ++++++++++---------- docs/installation/getting-started.md | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/developer/projects.md b/docs/developer/projects.md index 7420cb4..84484e2 100644 --- a/docs/developer/projects.md +++ b/docs/developer/projects.md @@ -1,16 +1,16 @@ -# Main projects and Python packages used by Argos +# Main projects used by Argos ## Python packages -- [Click](https://click.palletsprojects.com/) -- [FastAPI](https://fastapi.tiangolo.com/) -- [HTTPX](https://www.python-httpx.org/) -- [Jinja](https://jinja.palletsprojects.com/) -- [Pydantic](https://pydantic.dev/) -- [SQLAlchemy](https://www.sqlalchemy.org/) -- [Tenacity](https://github.com/jd/tenacity) -- [Uvicorn](https://www.uvicorn.org/) +- [Click](https://click.palletsprojects.com/) for the command-line interface ; +- [FastAPI](https://fastapi.tiangolo.com/) is the framework that allows us to expose the HTTP API ; +- [HTTPX](https://www.python-httpx.org/) is used to issue asynchronous requests in the agents ; +- [Jinja](https://jinja.palletsprojects.com/) is handling the templating ; +- [Pydantic](https://pydantic.dev/) is useful to ensure the data matches our expectactions ; +- [SQLAlchemy](https://www.sqlalchemy.org/) is the ORM we use, to connect to our database and issue queries ; +- [Tenacity](https://github.com/jd/tenacity) a small utility to retry a function in case an error occured ; +- [Uvicorn](https://www.uvicorn.org/) is the tool used to run our server. ## CSS framework -- [Pico.css](https://picocss.com/) +- [Pico.css](https://picocss.com/), a minimalist CSS framework, which does just what you need :-) diff --git a/docs/installation/getting-started.md b/docs/installation/getting-started.md index e66c14f..2eeb828 100644 --- a/docs/installation/getting-started.md +++ b/docs/installation/getting-started.md @@ -51,11 +51,11 @@ You can run the agent on the same machine as the server, or on a different machi argos agent http://localhost:8000 "" ``` -## Running cleaning tasks +## Cleaning the database You also have to run cleaning tasks periodically. `argos server clean --help` will give you more information on how to do that. -Here is a crontab example: +Here is a crontab example, which will clean the db each hour: ```bash # Run the cleaning tasks every hour (at minute 7)