Skip to content

Commit b60a76c

Browse files
committed
feat(news-agency): add docu for news agency notification to guides + release notes
1 parent b728a85 commit b60a76c

File tree

6 files changed

+169
-4
lines changed

6 files changed

+169
-4
lines changed

content/guides/integrations/news-agencies.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,3 +236,50 @@ POST /api/{{< api-version >}}/import/documents
236236
]
237237
}
238238
```
239+
240+
## Setup of news agencies notifications
241+
242+
To enable notifications for news agency reports, you need to extend the configuration as follows:
243+
244+
Within the [`newsAgency` property]({{< ref "/reference/project-config/news-agencies" >}}), add a property named notifications.
245+
This property specifies the categories that users can subscribe to in order to receive notifications.
246+
247+
If the notifications property is empty or missing, users will neither be able to configure notification settings nor receive any notifications.
248+
249+
```js
250+
newsAgency: {
251+
// ...
252+
notifications: [
253+
{
254+
handle: 'politics',
255+
label: {en: 'Politics', de: 'Politik'},
256+
category: 'politics'
257+
},
258+
{
259+
handle: 'economy',
260+
label: {en: 'Economy', de: 'Wirtschaft'},
261+
category: 'economy'
262+
},
263+
{
264+
handle: 'sports',
265+
label: {en: 'Sports', de: 'Sport'},
266+
category: 'sports'
267+
},
268+
{
269+
handle: 'feuilleton',
270+
label: {en: 'Feuilleton', de: 'Feuilleton'},
271+
category: 'feuilleton'
272+
},
273+
{
274+
handle: 'media',
275+
label: {en: 'Media', de: 'Medien'},
276+
category: 'media'
277+
},
278+
{
279+
handle: 'other',
280+
label: {en: 'Other', de: 'Sonstiges'},
281+
category: 'other'
282+
}
283+
]
284+
}
285+
```
59 KB
Loading
160 KB
Loading
80.3 KB
Loading

content/operations/releases/release-2025-09.md

Lines changed: 86 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ header:
1212
maintained: false
1313
branchHandle: release-2025-09
1414

15-
1615
systemRequirements:
1716
suggested:
1817
- name: Node
@@ -65,6 +64,7 @@ These are the release notes of the upcoming release (pull requests merged to the
6564
- :fire: Integration against the upcoming release (currently `master` branch) is at your own risk
6665

6766
## PRs to Categorize
67+
6868
- [fix(deps): update dependency webpack from 5.101.2 to v5.101.3 (main)](https://github.com/livingdocsIO/livingdocs-editor/pull/10214)
6969
- [fix(deps): update pintura [main]](https://github.com/livingdocsIO/livingdocs-editor/pull/10207)
7070
- [Polish Package Release-2025-09](https://github.com/livingdocsIO/livingdocs-editor/pull/10202)
@@ -78,7 +78,7 @@ These are the release notes of the upcoming release (pull requests merged to the
7878
- [fix(deps): update dependency copy-webpack-plugin from 13.0.0 to v13.0.1 (main)](https://github.com/livingdocsIO/livingdocs-editor/pull/10199)
7979
- [fix(deps): update dependency mini-css-extract-plugin from 2.9.3 to v2.9.4 (main)](https://github.com/livingdocsIO/livingdocs-editor/pull/10198)
8080
- [chore(deps): update dependency eslint from 9.32.0 to v9.33.0 (main)](https://github.com/livingdocsIO/livingdocs-server/pull/8264)
81-
- [Reinstantiate and deprecate unpublishing documents with publicationApi._scheduledPublish](https://github.com/livingdocsIO/livingdocs-server/pull/8254)
81+
- [Reinstantiate and deprecate unpublishing documents with publicationApi.\_scheduledPublish](https://github.com/livingdocsIO/livingdocs-server/pull/8254)
8282
- [Force index use when getting assets by key to improve serve-image endpoint performance](https://github.com/livingdocsIO/livingdocs-server/pull/8253)
8383
- [fix(deps): update aws-sdk from 3.850.0 to v3.859.0 (main) (minor)](https://github.com/livingdocsIO/livingdocs-server/pull/8234)
8484
- [fix(deps): update dependency mini-css-extract-plugin from 2.9.2 to v2.9.3 (main)](https://github.com/livingdocsIO/livingdocs-editor/pull/10191)
@@ -134,7 +134,6 @@ These are the release notes of the upcoming release (pull requests merged to the
134134
- [fix(deps): update dependency @elastic/elasticsearch from 9.0.2 to v9.0.3 (main)](https://github.com/livingdocsIO/livingdocs-server/pull/8154)
135135
- [fix(deps): update aws-sdk from 3.837.0 to v3.840.0 (main) (minor)](https://github.com/livingdocsIO/livingdocs-server/pull/8139)
136136

137-
138137
To get an overview about new functionality, read the [Release Notes](TODO).
139138
To learn about the necessary actions to update Livingdocs to `release-2025-09`, read on.
140139

@@ -201,12 +200,95 @@ livingdocs-server migrate up
201200

202201
TODO: check migration
203202

204-
205203
## Deprecations
206204

207205
## Features
208206

207+
### News Agency Notifications
208+
209+
It is now possible to receive notifications for news agency reports directly in Livingdocs. Once enabled, these notifications appear throughout the application - whether on a dashboard, in the editor, or in any other view. They inform users that a new news agency report matching the defined criteria is available. From there, an article can be created instantly with just one click.
210+
211+
To ensure users stay informed even when they are not actively working in Livingdocs, the favicon is highlighted whenever a new notification is available. In addition, browser notifications can be activated to alert users outside of the Livingdocs tab as soon as a new report is received.
212+
213+
#### Criteria for receiving News Agency Notifications
214+
215+
An incoming news agency report will always be displayed on the news agency screen if its criteria match the screen’s configuration.
216+
However, a notification will only be triggered if all of the following conditions are met:
217+
218+
- The news agency report has a Priority 1 or Priority 2.
219+
- Notifications are enabled and the sleep timer is deactivated.
220+
- The corresponding category of the report is selected in the news agency notification settings.
221+
- The report has not already been received by Livingdocs.
222+
223+
#### News Agency Notification Settings
224+
225+
The settings for news agency notifications are available on every news agency screen. To show the settings, its icon must be clicked. It is located next to the display filters at the top of the document list and indicates the current status: Disabled, Enabled, Sleep Timer Active.
226+
227+
Clicking the icon opens the settings. When the toggle is switched on, a list of all configured categories is displayed. Notifications are delivered for all categories that are checked.
228+
229+
<!-- Configure these categories using the `notifications` property inside the [`newsAgency` property]({{< ref "/reference/project-config/news-agencies" >}}): -->
230+
231+
Configure these categories using the `notifications` property inside the `newsAgency` property:
232+
233+
```js
234+
newsAgency: {
235+
notifications: [
236+
{
237+
handle: 'politics',
238+
label: {en: 'Politics', de: 'Politik'},
239+
category: 'Politik'
240+
}
241+
// ...
242+
]
243+
}
244+
```
245+
246+
In addition to enabling or disabling notifications and adjusting the category selection, users can also activate a sleep timer to temporarily mute notifications. Settings changes are persisted per user.
247+
It can also contain a hint regarding browser notifications, if they are unset or disabled (see respective sections below for more information).
248+
249+
{{< img width="300" src="./release-2025-09-news-agencies-notification-settings.png" alt="News Agency Notification Settings" >}}
250+
251+
#### News Agency Notifications Modal
252+
253+
When all notification criteria are met, a notification will appear in the top center of the Livingdocs interface.
254+
It contains a cell representing the news agency report, including the timestamp, title, source, and a plus button. Clicking the plus button immediately creates a Livingdocs article based on this report.
255+
Below the report cell, users can either toggle notifications on/off or activate the sleep timer, just as in the notification settings. Additionally, a Details button opens the full report details, mirroring the side panel on the news agency screen.
256+
If multiple notifications are present, a navigation element appears in the top-right corner. Users can click the arrows to browse through all received news flash reports. The currently opened notification remains active and visible, even when new notifications arrive.
257+
258+
These notifications behave similarly to other Livingdocs notifications (e.g. error messages). They overlay all other interface elements. While interacting directly with the notification and its content, the background remains inactive. However, when clicking or working outside of the notification, the rest of the interface behaves as usual.
259+
260+
{{< img src="./release-2025-09-news-agencies-notifications-decollapsed.png" alt="News Agency Notifications Decollapsed" >}}
261+
{{< img src="./release-2025-09-news-agencies-notifications-collapsed.png" alt="News Agency Notifications Collapsed" >}}
262+
263+
A notification will remain visible until one of the following occurs:
264+
265+
- An article is created directly from the notification using the plus button.
266+
- The notification is closed manually via the close button in the top-right corner.
267+
- 30 minutes have passed. In this case, only the specific notification that reached the 30-minute limit will disappear; other notifications remain unaffected.
268+
269+
Notifications and news agency settings are synchronized across all open browser tabs. When a notification is closed in one tab, it is automatically closed in all other tabs. The same applies when a new notification is received - it becomes visible in every open tab.
270+
271+
When notifications are open, the favicon changes. A small red circle is added on top of the Livingdocs logo (the default favicon). Once all notifications are closed, the favicon reverts to its normal state. This visual cue ensures that users can easily recognize when new notifications are available - even if no Livingdocs tab is currently active.
272+
273+
#### Sleep Timer
274+
275+
The sleep timer can be activated to temporarily mute notifications, allowing you to pause alerts until the next day without disabling notifications entirely. Once the remaining time has passed, notifications will automatically resume.
276+
277+
While active, the sleep timer also displays the remaining time until notifications are re-enabled.
278+
If news agency notifications are switched off completely, the sleep timer will be deactivated as well.
279+
280+
The sleep timer is available both in the News Agency Notification Settings and in the Notification Modal.
281+
282+
#### Browser Notification
283+
284+
Livingdocs now supports browser notifications for incoming news agency reports that meet the notification criteria, providing a way to receive alerts outside of the application.
285+
When opening the new agency notification settings for the first time, the browser will ask users to grant permission for Livingdocs notifications (by default, this setting is unset).
286+
If the user declines, a permanent hint will be shown in the News Agency Notification Settings.
287+
If the user accepts, in addition to the in-app News Agency Notification, a browser notification will be displayed.
288+
289+
The browser notification itself contains only the title of the incoming news agency report that matches the criteria. Handling of the notification depends entirely on the browser and on the users system (computer) settings. Livingdocs has no control over the appearance, duration, or sound of these notifications.
209290

291+
Note: When sharing your screen in a video call, or if system notifications are disabled, browser notifications may not be displayed at all.
210292

211293
## Vulnerability Patches
212294

content/reference/project-config/news-agencies.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The configuration is located in the Project Config under the `newsAgency` proper
1919

2020
- `functionHandle` refers to a registered news agency function. This function is used to copy news agency reports into regular articles or, in the auto-publish flow, to also update already copied articles.
2121
- `screens` defines one or more news agency screens in the Livingdocs Editor.
22+
- `notifications` represent the categories displayed in the notification settings, which are visible for each news agency screen. To be applicable, these must align with the available categories.
2223

2324
```js
2425
newsAgency: {
@@ -64,5 +65,40 @@ newsAgency: {
6465
]
6566
}
6667
]
68+
69+
// Optional. Configures the categories, which are shown in the notifications settings.
70+
// The should match the available categories.
71+
notifications: [
72+
{
73+
handle: 'politics',
74+
label: {en: 'Politics', de: 'Politik'},
75+
category: 'politics'
76+
},
77+
{
78+
handle: 'economy',
79+
label: {en: 'Economy', de: 'Wirtschaft'},
80+
category: 'economy'
81+
},
82+
{
83+
handle: 'sports',
84+
label: {en: 'Sports', de: 'Sport'},
85+
category: 'sports'
86+
},
87+
{
88+
handle: 'feuilleton',
89+
label: {en: 'Feuilleton', de: 'Feuilleton'},
90+
category: 'feuilleton'
91+
},
92+
{
93+
handle: 'media',
94+
label: {en: 'Media', de: 'Medien'},
95+
category: 'media'
96+
},
97+
{
98+
handle: 'other',
99+
label: {en: 'Other', de: 'Sonstiges'},
100+
category: 'other'
101+
}
102+
]
67103
}
68104
```

0 commit comments

Comments
 (0)