alignak-monitoring / alignak-doc Goto Github PK

04-1_alignak_configuration/arbiter.rst talks about much more than arbiter. It did not helped me to understand.

Attempting to follow instructions in documentation do not work.

PR is waiting to be merged. Comments reference a solution that appears to not have been implemented.
#30

The file 20_annexes/macros_list.rst use several refs that does not exists any more.

Mainly they are about #ochp_command but some others exist.

The doc section concerning alignak.cfg parameters is to be reviewed and updated. Some parameters ane not used or deprecated ...

Have a page with link docs related to the project (like alignak-backend).
It will be more usable for the users

I find it shocking ; imho a documentation should be attached/stored along to what it is documenting..

So that if/when an API/feature/whatever is changed/introduced then the relevant documentation should also be changed/introduced ; in the same branch or even commit.

Most (very well maintained) opensource software projects are doing this, I can give plenty of them very good : Django, celery, requests, flask, tornado, ansible, sentry, scrapy, ipython, boto, etc, etc etc (and etc..) ..

In fact this is really very common (and best) practice to include the documentation of a software in the same repository than the source code itself..

Some external commands seems not up to date are missing some hint:

1. ACKNOWLEDGE_HOST_PROBLEM

• Code section (ACKNOWLEDGE_HOST_PROBLEM;<host_name>;<sticky>;...) seems broken.
• Sticky, notify and persistent need other value (e.g.: if sticky not set to 2, what is the other value ?)

2. ACKNOWLEDGE_SVC_PROBLEM

• This command must provide the name of the service and not its description
• Sticky, notify and persistent need other value (as in ACKNOWLEDGE_HOST_PROBLEM)

3. SCHEDULE_HOST_DOWNTIME and SCHEDULE_SVC_DOWNTIME

This commands needs same change than for Acknowledge: name of service instead of service description.

I did not check the other commands, but there seems to be others where service_description needs to be changed.

It's not clear for people want to use realms and so multiple alignak servers.

Todo:

• describe how declare url of each modules of remote alignak in master alignak server
• different cases of relams and sub-realms

After a fresh install, some simple remarks and comments ...

The doc should state that:

• the standard nagios-plugins are required for the default configuration
• the default notification command requires a mail client (/usr/bin/mail must exist ...)