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

Merge pull request #25413 from mareklibra/docs.notifications

Browse Source 
User documentation for the Notifications and Signals
This commit is contained in:
Andre Wanlin
2024-08-07 09:56:17 -05:00
committed by GitHub
parent 0a076dcafb 8e185e43ce
commit 1604a92aee
7 changed files with 328 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/notifications/README.md
+2 -29
View File
@@ -2,38 +2,11 @@
Welcome to the notifications plugin!
_This plugin was created through the Backstage CLI_
## Getting started
First, install the `@backstage/plugin-notifications-backend` and `@backstage/plugin-notifications-node` packages.
See the documentation for installation instructions.
To install, please refer the [Getting Started](https://backstage.io/docs/notifications) Backstage Notifications and Signals documentation section.
To add the notifications main menu, add the following to your `packages/app/src/components/Root/Root.tsx`:
```tsx
import { NotificationsSidebarItem } from '@backstage/plugin-notifications';
<SidebarPage>
<Sidebar>
<SidebarGroup>
// ...
<NotificationsSidebarItem />
</SidebarGroup>
</Sidebar>
</SidebarPage>;
```
Also add the route to notifications to `packages/app/src/App.tsx`:
```tsx
import { NotificationsPage } from '@backstage/plugin-notifications';
<FlatRoutes>
// ...
<Route path="/notifications" element={<NotificationsPage />} />
</FlatRoutes>;
```
Please mind installing the `@backstage/plugin-notifications-backend` and `@backstage/plugin-notifications-node` packages before this frontend plugin.
## Real-time notifications