From 8e185e43ce5d4d99369d45358393f5d4d2ff1908 Mon Sep 17 00:00:00 2001 From: Marek Libra Date: Wed, 7 Aug 2024 15:04:20 +0200 Subject: [PATCH] Add Notifications to documentation sidebar Signed-off-by: Marek Libra --- docs/notifications/{getting-started.md => index.md} | 4 ++-- microsite/sidebars.json | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) rename docs/notifications/{getting-started.md => index.md} (98%) diff --git a/docs/notifications/getting-started.md b/docs/notifications/index.md similarity index 98% rename from docs/notifications/getting-started.md rename to docs/notifications/index.md index dc006e21b2..95d77a9b7f 100644 --- a/docs/notifications/getting-started.md +++ b/docs/notifications/index.md @@ -1,5 +1,5 @@ --- -id: getting-started +id: index title: Getting Started description: How to get started with the notifications and signals --- @@ -203,7 +203,7 @@ The use of signals with notifications is optional but generally enhances user ex When a notification is created, a new signal is emitted to a general-purpose message bus to announce it to subscribed listeners. -The frontend maintains a persistent connection (web socket) to receive these announcements from the notifications channel. +The frontend maintains a persistent connection (WebSocket) to receive these announcements from the notifications channel. The specific details of the updated or created notification should be retrieved via a request to the notifications API, except for new notifications, where the payload is included in the signal for performance reasons. In a frontend plugin, to subscribe for notifications' signals: diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 075025afbb..71d0257dc7 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -295,6 +295,7 @@ "conf/writing", "conf/defining" ], + "Notifications": ["notifications/index"], "Auth and identity": [ "auth/index", {