paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 32 Packages Projects Releases Wiki Activity

Add Notifications to documentation sidebar

Browse Source 
Signed-off-by: Marek Libra <marek.libra@gmail.com>
This commit is contained in:
Marek Libra
2024-08-07 15:04:20 +02:00
parent f4612847a2
commit 8e185e43ce
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/notifications/getting-started.md → docs/notifications/index.md
+2 -2
View File
@@ -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: