Revamp docs

[ychiucco]

closes #2825

Checklist before merging

• I added an appropriate entry to CHANGELOG.md
• I added logging to new code - if appropriate.
• I merged main into the current branch.

[github-actions]

Benchmark comparison

GET /api/alive/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
vanilla	0.7	0.8	0.87	0.0	0.0
power	0.7	0.7	1.00	0.0	0.0
dataset	0.7	0.6	1.17	0.0	0.0
project	0.7	0.6	1.17	0.0	0.0
job	0.7	0.6	1.17	0.0	0.0

GET /api/v2/dataset/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
vanilla	7.2	6.8	1.06	0.2	0.2
power	211.7	194.6	1.09	89.5	89.5
dataset	85.3	79.9	1.07	4.6	4.6
project	17.7	18.1	0.98	5.8	5.8
job	7.0	6.0	1.17	0.2	0.2

GET /api/v2/job/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
vanilla	5.4	4.4	1.23	2.7	2.7
power	49.1	44.2	1.11	787.5	787.5
dataset	51.7	44.0	1.18	1097.6	1097.6
project	17.0	17.6	0.97	343.9	343.9
job	15.3	12.7	1.20	273.1	273.1

GET /api/v2/project/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
vanilla	5.5	4.7	1.17	0.1	0.1
power	5.3	4.6	1.15	0.1	0.1
dataset	5.3	4.6	1.15	0.1	0.1
project	6.4	5.7	1.12	2.3	2.3
job	5.1	4.9	1.04	0.1	0.1

GET /api/v2/task/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
vanilla	5.5	5.2	1.06	0.8	0.8
power	5.1	4.7	1.09	0.8	0.8
dataset	5.2	4.7	1.11	0.8	0.8
project	5.4	4.7	1.15	0.8	0.8
job	5.7	4.7	1.21	0.8	0.8

GET /api/v2/task-group/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
vanilla	7.1	6.6	1.08	1.8	1.8
power	6.9	6.4	1.08	1.8	1.8
dataset	7.0	6.4	1.09	1.8	1.8
project	7.0	6.3	1.11	1.8	1.8
job	6.7	5.9	1.14	1.8	1.8

GET /api/v2/workflow/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
vanilla	8.0	7.8	1.03	0.8	0.8
power	14.8	10.7	1.38	28.0	28.0
dataset	10.2	9.5	1.07	16.2	16.2
project	12.0	11.1	1.08	20.4	20.4
job	8.4	7.5	1.12	0.8	0.8

POST /api/v2/project/3/dataset/404/images/query/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
dataset	29.5	23.0	1.28	275.1	275.1

GET /auth/current-user/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
vanilla	4.2	6.3	0.67	0.2	0.2
power	3.0	2.7	1.11	0.2	0.2
dataset	2.9	2.7	1.07	0.2	0.2
project	2.9	2.7	1.07	0.2	0.2
job	2.9	2.8	1.04	0.2	0.2

POST /auth/token/login/

User	Time current (ms)	Time main (ms)	Ratio current/main	Size current (Kb)	Size main (Kb)
dataset	272.2	271.8	1.00	0.2	0.2

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
fractal_server
__main__.py
fractal_server/app/schemas/v2
accounting.py
dataset.py
resource.py
fractal_server/config
_data.py
_database.py
_email.py
_main.py
_oauth.py
fractal_server/runner/config
_slurm.py
fractal_server/runner/executors/slurm_common
get_slurm_config.py
fractal_server/tasks/v2/ssh
collect_pixi.py
deactivate.py
delete.py
reactivate.py
fractal_server/types
__init__.py
Project Total

This report was generated by python-coverage-comment-action