From a929590eb92a6ebb85e13183e37a9d417ab0b937 Mon Sep 17 00:00:00 2001 From: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com> Date: Thu, 26 Jan 2023 10:31:14 +0100 Subject: [PATCH] Switch to definition list per review Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com> --- .../internal/newsfragments/1415.clarification | 2 +- content/client-server-api/modules/push.md | 57 ++++++++++--------- 2 files changed, 32 insertions(+), 27 deletions(-) diff --git a/changelogs/internal/newsfragments/1415.clarification b/changelogs/internal/newsfragments/1415.clarification index 85f18e9f..390f37e3 100644 --- a/changelogs/internal/newsfragments/1415.clarification +++ b/changelogs/internal/newsfragments/1415.clarification @@ -1 +1 @@ -Improve formatting of push.md +Improve formatting of definitions in the Push Notifications section. diff --git a/content/client-server-api/modules/push.md b/content/client-server-api/modules/push.md index 8c698fd6..74da879f 100644 --- a/content/client-server-api/modules/push.md +++ b/content/client-server-api/modules/push.md @@ -50,35 +50,40 @@ such as Apple's APNS or Google's GCM. This happens as follows: Definitions for terms used in this section are below: -**Push Provider**: -A push provider is a service managed by the device vendor which can send -notifications directly to the device. Google Cloud Messaging (GCM) and -Apple Push Notification Service (APNS) are two examples of push -providers. +Push Provider -**Push Gateway**: -A push gateway is a server that receives HTTP event notifications from -homeservers and passes them on to a different protocol such as APNS for -iOS devices or GCM for Android devices. Clients inform the homeserver -which Push Gateway to send notifications to when it sets up a Pusher. +: A push provider is a service managed by the device vendor which can send + notifications directly to the device. Google Cloud Messaging (GCM) and + Apple Push Notification Service (APNS) are two examples of push + providers. -**Pusher**: -A pusher is a worker on the homeserver that manages the sending of HTTP -notifications for a user. A user can have multiple pushers: one per -device. +Push Gateway -**Push Rule**: -A push rule is a single rule that states under what *conditions* an -event should be passed onto a push gateway and *how* the notification -should be presented. These rules are stored on the user's homeserver. -They are manually configured by the user, who can create and view them -via the Client/Server API. +: A push gateway is a server that receives HTTP event notifications from + homeservers and passes them on to a different protocol such as APNS for + iOS devices or GCM for Android devices. Clients inform the homeserver + which Push Gateway to send notifications to when it sets up a Pusher. -**Push Ruleset**: -A push ruleset *scopes a set of rules according to some criteria*. For -example, some rules may only be applied for messages from a particular -sender, a particular room, or by default. The push ruleset contains the -entire set of scopes and rules. +Pusher + +: A pusher is a worker on the homeserver that manages the sending of HTTP + notifications for a user. A user can have multiple pushers: one per + device. + +Push Rule + +: A push rule is a single rule that states under what *conditions* an + event should be passed onto a push gateway and *how* the notification + should be presented. These rules are stored on the user's homeserver. + They are manually configured by the user, who can create and view them + via the Client/Server API. + +Push Ruleset + +: A push ruleset *scopes a set of rules according to some criteria*. For + example, some rules may only be applied for messages from a particular + sender, a particular room, or by default. The push ruleset contains the + entire set of scopes and rules. #### Client behaviour @@ -864,7 +869,7 @@ than the room, sender and content rules): ##### Recommendations for APNS The exact format for sending APNS notifications is flexible and up to -the client app and its' push gateway to agree on. As APNS requires that +the client app and its push gateway to agree on. As APNS requires that the sender has a private key owned by the app developer, each app must have its own push gateway. It is recommended that: