logdata-anomaly-miner icon indicating copy to clipboard operation
logdata-anomaly-miner copied to clipboard

Create proper documentation of all aminer-resources

Open whotwagner opened this issue 4 years ago • 2 comments

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

whotwagner avatar Jan 26 '21 13:01 whotwagner

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 avatar Jan 27 '21 07:01 landauermax

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.

landauermax avatar Feb 16 '21 12:02 landauermax