Create proper documentation of all aminer-resources

ait-aecid / logdata-anomaly-miner

This tool parses log data and allows to define analysis pipelines for anomaly detection. It was designed to run the analysis with limited resources and lowest possible permissions to make it suitable for production server use.

GNU General Public License v3.0

79 stars 24 forks source link

Create proper documentation of all aminer-resources #411

Open whotwagner opened 3 years ago

whotwagner commented 3 years ago

The AMiner needs a solid documentation. https://readthedocs.org/ might be a good place to put the documentation to. Key-Requirements are:

Full coverage of all aminer-functionality
Full coverage of all aminer-components
Versioning

landauermax commented 3 years ago

Maybe it is also a good idea to provide sample configurations (only the relevant section of the config.yml) with every description of component. These examples should already exist anyway (demo in aecid-testsuite).

landauermax commented 3 years ago

Also, https://github.com/ait-aecid/logdata-anomaly-miner/tree/main/source/root/usr/share/doc/logdata-anomaly-miner/aminer is outdated, e.g., it is missing some detectors. We should make sure to only create the documentation once and then cross-link it to the Wiki and other relevant places.