Documentation on key concepts

[martialblog]

Hi,

I feel like the documentation is missing an introduction to the key concepts of Icinga Notifications.

The 01-About page should maybe introduce what we then see in the web interface

• What is an Event
• What is an Incident
• What is an Event Rule and how does it work
• What is a Contact, Group, Schedule
• What is a Channel
• and so on

The Event Rules in particular could use a detailed documentation.

If this is an issue for icinga-notifications-web, feel free to move the issue

Regards, Markus

[nilmerg]

This is planned to be covered by a blog series.

[martialblog]

Looking forward to the series.

However, I still think there's merit in having these key concepts in the documentation. First, I think it is good to have everything in one place and second, blog posts are usually not edited over time. So If we want to update/change/improve the documentation in these key concepts a blog post probably won't be updated.

[oxzi]

I wrote some paragraphs last week, trying to both ease the initial steps while explaining some concepts on the way: https://icinga.com/blog/2024/08/07/getting-started-with-icinga-notifications/

However, imho this does not replace solid documentation.

[martialblog]

I think it describes the key concepts very well and most of it could just be copied in a "key concepts" or the "about" section in the docs.

[theFeu]

I just had a chat with @julianbrost and we thought it might make sense to reuse parts of the blogpost in the docs. The concepts are explained rather well there, and it would be a shame if they just drowned in the blog after a while :)

[jprusch]

Hopping in on this one... I'm just evaluating notifications, great solution & I got it working with Mattermost sending a webhook request. The most difficult part was finding out, what is supported on the JSON payload of a webhook channel. Some documentation on this topic would be great.

[jprusch]

Second topic would be the use of filters when creating an event rule.