search

Icinga / icinga-notifications

Icinga Notifications: new and improved notifications and incident management for Icinga (work in progress, not ready for production yet)
GNU General Public License v2.0
10 stars 0 forks source link

Increase details of Channels documentation #236

Closed oxzi closed 4 months ago

oxzi commented 4 months ago

With a release approaching, the Channels documentation got more information about how the Channel system actually work and how to build your own channels.

The internal/changes/examples JSON files were inlined to ease the readability and updated, as they contained partially outdated information.

For the pkg/plugin part, some API documentation was added as this might get used by external users.

oxzi commented 4 months ago

I reworked some parts, especially to mention changes from #206. Furthermore, I described how the channel configuration through the two RPC methods works and how a channel plugin is expected to behave. As the documentation links to the Go API doc, I added more API docs for the fields.

Please take another look.

julianbrost commented 4 months ago

@martialblog Do you want to have another look as well, i.e. should I wait with merging this a bit?

martialblog commented 4 months ago

@julianbrost Thanks, I was away these last days. If I find something I'll just open a PR.

Looking forward to v0.1.0