diff --git a/README.md b/README.md index bff707c97..f07cd8bd1 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Alertmanager instances it was found at and can be filtered based on those tags (`@alertmanager`). Note that `@alertmanager` tags will be visible only if karma is configured with multiple Alertmanager instances. -![Screenshot](/docs/screenshot.png) +![Screenshot](/docs/img/screenshot.png) Alerts are displayed grouped preserving [group_by](https://prometheus.io/docs/alerting/configuration/#route) @@ -36,30 +36,32 @@ icon. Each individual alert will show unique labels and annotations. Labels and annotations that are shared between all alerts are moved to the footer. -![Example](/docs/alertGroup.png) +![Example](/docs/img/alertGroup.png) If all alerts in a group were suppressed by the same silence then, to save screen space, the silence will also be moved to the footer. -![Deduplicated silence](/docs/footerSilence.png) +![Deduplicated silence](/docs/img/footerSilence.png) Silence modal allows to create new silences and manage all silences already present in Alertmanager. -![Silence browser](/docs/silenceBrowser.png) +![Silence browser](/docs/img/silenceBrowser.png) Clicking on the alert counter in the top left corner will open the overview modal, which allows to quickly get an overview of the top label values for all current alerts. -![Overview](/docs/overview.png) +![Overview](/docs/img/overview.png) Starting with `v0.50` karma can create short lived silences to acknowledge alerts with a single button click. To create silences that will resolve itself only after all alerts are resolved you can use [kthxbye](https://github.com/prymitive/kthxbye). See [configuration docs](/docs/CONFIGURATION.md#alert-acknowledgement) for -details. +details. Example: + +![Acknowledgement demo](/docs/img/ack.gif) [Online demo](https://karma-demo.herokuapp.com/) diff --git a/docs/img/ack.gif b/docs/img/ack.gif new file mode 100644 index 000000000..84ad500a1 Binary files /dev/null and b/docs/img/ack.gif differ diff --git a/docs/alertGroup.png b/docs/img/alertGroup.png similarity index 100% rename from docs/alertGroup.png rename to docs/img/alertGroup.png diff --git a/docs/footerSilence.png b/docs/img/footerSilence.png similarity index 100% rename from docs/footerSilence.png rename to docs/img/footerSilence.png diff --git a/docs/overview.png b/docs/img/overview.png similarity index 100% rename from docs/overview.png rename to docs/img/overview.png diff --git a/docs/screenshot.png b/docs/img/screenshot.png similarity index 100% rename from docs/screenshot.png rename to docs/img/screenshot.png diff --git a/docs/silenceBrowser.png b/docs/img/silenceBrowser.png similarity index 100% rename from docs/silenceBrowser.png rename to docs/img/silenceBrowser.png