Improvements of documentation
Goal
TODO / How to implement
-
Transfer documentation to https://readthedocs.org/. https://gitlab.com/postgres-ai-team/postgres-checkup/issues/335. -
Move the link to the Demo to the top. -
Short description about every check: what problems can you detect and prevent. -
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
-
-
Give the link to the particular checkup example report, e.g. for A001 - https://gitlab.com/postgres-ai-team/postgres-checkup-tests/blob/master/master/md_reports/1_2019_02_27T12_05_13_+0000/A001.md. -
Improve documentation about the most vital metrics and figures in every report to make the work with every particular report easier. -
More examples to Example of Use
:
-
how to run one perticular report
-
ho to connect via ssh with key
-
how to regenerate MD report based on json-specified
-
Add section How it works
and diagrams.
Acceptance criteria
Edited by Anna