Improve descriptions of all checks
Goal
Improve documentation, explaining what every check is for, what problems and bottlenecks it helps to prevent or detect.
TODO / How to implement
- To improve documentation about every check: https://gitlab.com/postgres-ai-team/internal/wikis/Description-of-checkups
The description can include answers to the following questions:
- General description: why does the client need this check? What is this check for? What problems it helps to detect and solve?
- What sections does this check consist of? What is the point of every section?
- Explanation of the main metrics, used in every check (if necessary).
These groups of checks should be covered:
-
A XXX https://gitlab.com/postgres-ai-team/postgres-checkup/issues/336 -
D XXX https://gitlab.com/postgres-ai-team/postgres-checkup/issues/337 -
F XXX https://gitlab.com/postgres-ai-team/postgres-checkup/issues/338 -
G XXX https://gitlab.com/postgres-ai-team/postgres-checkup/issues/339 -
H XXX https://gitlab.com/postgres-ai-team/postgres-checkup/issues/340 -
K XXX https://gitlab.com/postgres-ai-team/postgres-checkup/issues/341 -
L XXX https://gitlab.com/postgres-ai-team/postgres-checkup/issues/342
- To have the descriptions checked by @ane4ka @NikolayS and on https://fluent.express/.
Acceptance criteria
As a user, I see descriptions for all checks of postgres-checkup, when entering documentation. This description helps to understand better, what every check is about.