From 50f0b94ce0942d1da5913b71125b388ad1ddb46a Mon Sep 17 00:00:00 2001 From: Three7Six <48099849+Three7Six@users.noreply.github.com> Date: Thu, 28 Feb 2019 09:29:47 -0800 Subject: [PATCH 1/2] Update README.md Fixed some grammatical and punctuation errors to increase readability. --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 48914ff5e..1fd365aa5 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,8 @@ Alert dashboard for Alertmanager UI is useful for browsing alerts and managing silences, but it's lacking as a dashboard tool - karma aims to fill this gap. -Starting with `0.7.0` release it can also aggregate alerts from multiple -Alertmanager instances, running either in HA mode or separate. Duplicated alerts -are deduplicated so only unique alerts are displayed. Each alert is tagged with -names of all Alertmanager instances it was found at and can be filtered based +Starting with the `0.7.0` release it can aggregate alerts from multiple +Alertmanager instances, running either in HA mode or separate. Unique alerts are displayed by filtering duplicates. Each alert is tagged with the names of all 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. @@ -17,11 +15,11 @@ only if karma is configured with multiple Alertmanager instances. Alerts are displayed grouped preserving [group_by](https://prometheus.io/docs/alerting/configuration/#route) configuration option in Alertmanager. If a group contains multiple alerts only -first few alerts will be presented, the rest can be expanded or hidden +the first few alerts will be presented. Alerts are expanded or hidden using - / + buttons. The default number of alerts can be configured in the UI settings module. -Each individual alert will only show unique labels and annotations, labels -and annotations that are shared between all alerts will be moved to the footer. +Each individual alert will show unique labels and annotations. Labels +and annotations that are shared between all alerts are moved to the footer. Example: ![Example](/alertGroup.png) From cada9d0d9c355c1a62658512bf44342cf568108a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Mierzwa?= Date: Thu, 28 Feb 2019 22:01:20 +0000 Subject: [PATCH 2/2] fix(docs): break long lines to make markdown linter happy --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1fd365aa5..2955d649e 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,11 @@ Alert dashboard for Alertmanager UI is useful for browsing alerts and managing silences, but it's lacking as a dashboard tool - karma aims to fill this gap. Starting with the `0.7.0` release it can aggregate alerts from multiple -Alertmanager instances, running either in HA mode or separate. Unique alerts are displayed by filtering duplicates. Each alert is tagged with the names of all 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. +Alertmanager instances, running either in HA mode or separate. Unique alerts are +displayed by filtering duplicates. Each alert is tagged with the names of all +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](/screenshot.png)