From 143a093e20ac9b49aec656e5c108e6a92633e33e Mon Sep 17 00:00:00 2001 From: Salim B Date: Thu, 7 Mar 2024 01:40:19 +0100 Subject: [PATCH] docs(alerting): Fix wrong gitlab terminology (alert key vs. PAT) (#694) Fix wrong term (alert key vs. PAT) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 24971529..74c9d3cf 100644 --- a/README.md +++ b/README.md @@ -596,15 +596,15 @@ endpoints: ![GitHub alert](.github/assets/github-alerts.png) #### Configuring GitLab alerts -| Parameter | Description | Default | +| Parameter | Description | Default | |:------------------------------------|:----------------------------------------------------------------------------------------------------------------|:--------------| | `alerting.gitlab` | Configuration for alerts of type `gitlab` | `{}` | | `alerting.gitlab.webhook-url` | GitLab alert webhook URL (e.g. `https://gitlab.com/hlidotbe/example/alerts/notify/gatus/xxxxxxxxxxxxxxxx.json`) | Required `""` | -| `alerting.gitlab.authorization-key` | Personal access token to use for authentication.
Must have at least RW on issues and RO on metadata. | Required `""` | +| `alerting.gitlab.authorization-key` | GitLab alert authorization key. | Required `""` | | `alerting.gitlab.severity` | Override default severity (critical), can be one of `critical, high, medium, low, info, unknown` | `""` | | `alerting.gitlab.monitoring-tool` | Override the monitoring tool name (gatus) | `"gatus"` | | `alerting.gitlab.environment-name` | Set gitlab environment's name. Required to display alerts on a dashboard. | `""` | -| `alerting.gitlab.service` | Override endpoint displayname | `""` | +| `alerting.gitlab.service` | Override endpoint displayname | `""` | | `alerting.gitlab.default-alert` | Default alert configuration.
See [Setting a default alert](#setting-a-default-alert). | N/A | The GitLab alerting provider creates an alert prefixed with `alert(gatus):` and suffixed with the endpoint's display