From 9371004bd056b5c7932bc1da6b6f53d0ff63a4ce Mon Sep 17 00:00:00 2001 From: Michael Friedrich Date: Wed, 7 Jun 2017 14:27:28 +0200 Subject: [PATCH] Docs: Fix formatting issues and broken URLs --- doc/13-addons.md | 2 +- doc/18-library-reference.md | 2 +- doc/23-appendix.md | 12 ++++++------ doc/3-monitoring-basics.md | 14 +++++--------- doc/4-configuring-icinga-2.md | 4 ++-- doc/9-object-types.md | 2 +- 6 files changed, 16 insertions(+), 20 deletions(-) diff --git a/doc/13-addons.md b/doc/13-addons.md index 4c7bfba7a..42ec0658b 100644 --- a/doc/13-addons.md +++ b/doc/13-addons.md @@ -108,7 +108,7 @@ More details can be found in [this blog post](https://www.icinga.com/2014/12/02/ There's a variety of resources available, for example different notification scripts such as: -* E-Mail ([examples](3-monitoring-basics.md#notifications) provided) +* E-Mail ([examples](3-monitoring-basics.md#alert-notifications) provided) * SMS * Pager (XMPP, etc.) * Twitter diff --git a/doc/18-library-reference.md b/doc/18-library-reference.md index 4c82ab4c1..9a545cfaa 100644 --- a/doc/18-library-reference.md +++ b/doc/18-library-reference.md @@ -1246,7 +1246,7 @@ Signature: Returns a list of keys for all items that are currently in the dictionary. -### Dictionary#values +### Dictionary#values Signature: diff --git a/doc/23-appendix.md b/doc/23-appendix.md index 902a29f7c..568c71c16 100644 --- a/doc/23-appendix.md +++ b/doc/23-appendix.md @@ -692,16 +692,16 @@ Not supported: `debug_info`. #### Livestatus Hostsbygroup Table Attributes -All [hosts](19-appendix.md#schema-livestatus-hosts-table-attributes) table attributes grouped with -the [hostgroups](19-appendix.md#schema-livestatus-hostgroups-table-attributes) table prefixed with `hostgroup_`. +All [hosts](23-appendix.md#schema-livestatus-hosts-table-attributes) table attributes grouped with +the [hostgroups](23-appendix.md#schema-livestatus-hostgroups-table-attributes) table prefixed with `hostgroup_`. #### Livestatus Servicesbygroup Table Attributes -All [services](19-appendix.md#schema-livestatus-services-table-attributes) table attributes grouped with -the [servicegroups](19-appendix.md#schema-livestatus-servicegroups-table-attributes) table prefixed with `servicegroup_`. +All [services](23-appendix.md#schema-livestatus-services-table-attributes) table attributes grouped with +the [servicegroups](23-appendix.md#schema-livestatus-servicegroups-table-attributes) table prefixed with `servicegroup_`. #### Livestatus Servicesbyhostgroup Table Attributes -All [services](19-appendix.md#schema-livestatus-services-table-attributes) table attributes grouped with -the [hostgroups](19-appendix.md#schema-livestatus-hostgroups-table-attributes) table prefixed with `hostgroup_`. +All [services](23-appendix.md#schema-livestatus-services-table-attributes) table attributes grouped with +the [hostgroups](23-appendix.md#schema-livestatus-hostgroups-table-attributes) table prefixed with `hostgroup_`. diff --git a/doc/3-monitoring-basics.md b/doc/3-monitoring-basics.md index ac7eb5bcb..087b3acdf 100644 --- a/doc/3-monitoring-basics.md +++ b/doc/3-monitoring-basics.md @@ -1021,7 +1021,7 @@ or with the `test_server` attribute set to `true` are **not** added to this grou Details on the `assign where` syntax can be found in the [Language Reference](17-language-reference.md#apply). -## Notifications +## Notifications Notifications for service and host problems are an integral part of your monitoring setup. @@ -1057,10 +1057,8 @@ object, notifications for all states and types will be sent. Details on troubleshooting notification problems can be found [here](15-troubleshooting.md#troubleshooting). -> **Note** -> -> Make sure that the [notification](11-cli-commands.md#enable-features) feature is enabled -> in order to execute notification commands. +**Note**: Make sure that the [notification](11-cli-commands.md#enable-features) feature is enabled +in order to execute notification commands. You should choose which information you (and your notified users) are interested in case of emergency, and also which information does not provide any value to you and @@ -1102,10 +1100,8 @@ Instead of assigning users to notifications, you can also add the `user_groups` attribute with a list of user groups to the `Notification` object. Icinga 2 will send notifications to all group members. -> **Note** -> -> Only users who have been notified of a problem before (`Warning`, `Critical`, `Unknown` -> states for services, `Down` for hosts) will receive `Recovery` notifications. +**Note**: Only users who have been notified of a problem before (`Warning`, `Critical`, `Unknown` +states for services, `Down` for hosts) will receive `Recovery` notifications. ### Notification Escalations diff --git a/doc/4-configuring-icinga-2.md b/doc/4-configuring-icinga-2.md index 9c595bba3..069275c8f 100644 --- a/doc/4-configuring-icinga-2.md +++ b/doc/4-configuring-icinga-2.md @@ -294,7 +294,7 @@ in [services.conf](4-configuring-icinga-2.md#services-conf). * define disks (all, specific `/`) and their attributes for the `disk` service apply rule defined in [services.conf](4-configuring-icinga-2.md#services-conf). * define notification types (`mail`) and set the groups attribute. This -will be used by notification apply rules in [notifications.conf](notifications-conf). +will be used by notification apply rules in [notifications.conf](4-configuring-icinga-2.md#notifications-conf). If you've installed [Icinga Web 2](2-getting-started.md#setting-up-icingaweb2), you can uncomment the http vhost attributes and reload Icinga 2. The apply @@ -562,7 +562,7 @@ implicitely use the `icingaadmins` UserGroup defined in [users.conf](4-configuri } More details on defining notifications and their additional attributes such as -filters can be read in [this chapter](3-monitoring-basics.md#notifications). +filters can be read in [this chapter](3-monitoring-basics.md#alert-notifications). #### commands.conf diff --git a/doc/9-object-types.md b/doc/9-object-types.md index 1a8e1123e..f05785745 100644 --- a/doc/9-object-types.md +++ b/doc/9-object-types.md @@ -1018,7 +1018,7 @@ of host and service state changes and other events. > usually easier to just create a `Notification` template and use the `apply` keyword > to assign the notification to a number of hosts or services. Use the `to` keyword > to set the specific target type for `Host` or `Service`. -> Check the [notifications](3-monitoring-basics.md#notifications) chapter for detailed examples. +> Check the [notifications](3-monitoring-basics.md#alert-notifications) chapter for detailed examples. Example: