Improvements in documentation regarding services

[sebthebert]

To ensure our recent conversation won't get lost, but may also become advantageous for someone lese in the future, I willl ist up some things I suggest for the future documentation.

1. Add to the documentation that "(pattern1|pattern2)" is not recommended (and why), but (?:pattern1|pattern2) is recommended instead, please. Maybe a reference to the official Perl documentation would be appropriate here as suggested.

2. Add to the documentation, that '(daemonname|DAEMONNAME)' is not necessary anyway because regexps are case insensitive in Octopussy (because 2 messages which are only different by their case, have the same meaning), please.

3. Add to the documentation that more than one <@:msg@>-tag is not recommended since it will cause problems within the repots generation of Octopussy, please.

4. Add to the documentation, that the ordering of patterns within a service is really important only in case one uses alert(s) and/or one activated statistics on these services and that in other cases, Octopussy generates a big global regexp with all patterns in one service. Also add a more extensive explaination of the nature of reports, please.

5. Add some sensible examples of generated alerts and/or wole alert classes to the documentation, please. This will ensure people understand the power and possibilities of Octopussy.

[sebthebert]

Date: 2012-02-10 14:41:31
Author: hollstein

I'm currently documenting Octopussy for the Company I work for. I'm gonna hand something back to you as soon as it is usable. :-]

TOC:

1 General Information About the Software
1.1 Design/Concept of the Software
1.2 Additional Documentation
2 [REMOVED]
3 Infrastructure
4 Software Configuration
4.1 Octopussy Frontend
4.1.1 Octopussy: Preferences
4.1.2 Octopussy: System
4.1.3 Octopussy: Contacts
4.1.4 Octopussy: Storages
4.1.5 Octopussy: Users
4.2 Octopussy Backend
4.2.1 Octopussy: Preferences
4.2.2 Octopussy: System
4.2.3 Octopussy: Contacts
4.2.4 Octopussy: Storages
4.2.5 Octopussy: Users
5 Software Administration
5.1 Octopussy Users
5.2 Adding Systems
5.2.1 System Configurations
5.2.2 Tips and Tricks
5.3 Adding Devices
5.4 Check the Log
5.5 Adding Patterns
5.5.1 Important Notes
5.5.2 Steps
5.5.3 Tips and Tricks
6.6 Adding new Reports
5.7 Adding new Alerts
6 Software Usage
7 Routine Changes

[sebthebert]

Date: 2012-02-13 01:39:40
Author: sebthebert

It will be AWESOME !

It will be a good start for me to finally make a good documentation about Octopussy.

Thanks for all your work in Octopussy !

[aydinnmu]

Thanks Sebastion, it will be very nice but also hard.

[sebthebert]

I created a new Github repository dedicated to Octopussy documentation.

I opened 2 isuses from this issue:
Octopussy-Project/Octopussy_Documentation#4
Octopussy-Project/Octopussy_Documentation#5