From 9c5bb3998ccdc77fcb16eaa08a43c6f2450745d2 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Wed, 13 Jan 2021 10:28:02 +0100 Subject: [PATCH] docs: fix minor grammar issues --- website/docs/events/notifications.md | 12 ++++++------ website/docs/events/transports.md | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/website/docs/events/notifications.md b/website/docs/events/notifications.md index 15c5a64b16..22b0aa9748 100644 --- a/website/docs/events/notifications.md +++ b/website/docs/events/notifications.md @@ -6,13 +6,13 @@ title: Notifications Starting with authentik 0.15, you can create notification triggers, which can alert you based on the creation of certain events. -Filtering is done by using the Policy Engine. You can do simple filtering using the "Event Matcher Policy" type +Filtering is done by using the Policy Engine. You can do simple filtering using the "Event Matcher Policy" type. ![](./event_matcher.png) -An Event has to match all configured fields, otherwise it will not match. +An event has to match all configured fields, otherwise the trigger will not activate. -To match events with an "Expression Policy", you can write code like so +To match events with an "Expression Policy", you can write code like so: ```python if "event" not in request.context: @@ -23,9 +23,9 @@ return ip_address(request.context["evnet"].client_ip) in ip_network('192.0.2.0/2 ## Selecting who gets notified -After you've create the policies to match the events you want, create a "Notification Trigger". +After you've created the policies to match the events you want, create a "Notification Trigger". You have to select which group the generated notification should be sent to. If left empty, the trigger will be disabled. -You also have to select which transports should be used to send the Notification. -A transport with the name "default-email-transport" is created by default. This transport will use the [global email configuration](../installation/docker-compose#email-configuration-optional-but-recommended) +You also have to select which transports should be used to send the notification. +A transport with the name "default-email-transport" is created by default. This transport will use the [global email configuration](../installation/docker-compose#email-configuration-optional-but-recommended). diff --git a/website/docs/events/transports.md b/website/docs/events/transports.md index d50293efd3..439d9cc159 100644 --- a/website/docs/events/transports.md +++ b/website/docs/events/transports.md @@ -2,7 +2,7 @@ title: Transports --- -Notifications can be sent to users via multiple mediums. Per default, the [global email configuration](../installation/docker-compose#email-configuration-optional-but-recommended) will be used. +Notifications can be sent to users via multiple mediums. By default, the [global email configuration](../installation/docker-compose#email-configuration-optional-but-recommended) will be used. ## Generic Webhook @@ -17,7 +17,7 @@ This will send a POST request to the given URL with the following contents: } ``` -The `Content-Type` Header is set to `text/json`. +The `Content-Type` header is set to `text/json`. :::warning This will send a request for each user of the group selected in the trigger. @@ -25,4 +25,4 @@ This will send a request for each user of the group selected in the trigger. ## Slack Webhook -This sends a request using the Slack-specific format. This is also compatible with Discord's Webhooks by appending `/slack`. +This sends a request using the Slack-specific format. This is also compatible with Discord's webhooks by appending `/slack` to the Discord webhook URL.