You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2023/12/12 08:08:56 UTC

(streampipes) 02/02: extend user documentation

This is an automated email from the ASF dual-hosted git repository.

bossenti pushed a commit to branch teams-sink-silence-period
in repository https://gitbox.apache.org/repos/asf/streampipes.git

commit a3e9208242b90e54156ebf93007c0c46516ec892
Author: bossenti <bo...@posteo.de>
AuthorDate: Tue Dec 12 09:08:45 2023 +0100

    extend user documentation
---
 .../documentation.md                                              | 6 ++++++
 .../documentation.md                                              | 8 +++++++-
 .../documentation.md                                              | 6 ++++++
 .../documentation.md                                              | 6 ++++++
 .../documentation.md                                              | 5 +++++
 .../documentation.md                                              | 6 ++++++
 6 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/streampipes-extensions/streampipes-sinks-internal-jvm/src/main/resources/org.apache.streampipes.sinks.internal.jvm.notification/documentation.md b/streampipes-extensions/streampipes-sinks-internal-jvm/src/main/resources/org.apache.streampipes.sinks.internal.jvm.notification/documentation.md
index e3878fc81..3ed06571d 100644
--- a/streampipes-extensions/streampipes-sinks-internal-jvm/src/main/resources/org.apache.streampipes.sinks.internal.jvm.notification/documentation.md
+++ b/streampipes-extensions/streampipes-sinks-internal-jvm/src/main/resources/org.apache.streampipes.sinks.internal.jvm.notification/documentation.md
@@ -46,6 +46,12 @@ The title of the notification.
 
 The notification message.
 
+### Silent Period
+
+The *Silent Period* is the duration, expressed in minutes, during which notifications are temporarily disabled after one
+has been sent. This feature is implemented to prevent overwhelming the target with frequent notifications, avoiding
+potential spam behavior.
+
 ## Output
 
 (not applicable for data sinks)
\ No newline at end of file
diff --git a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.email/documentation.md b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.email/documentation.md
index 47cacfebd..770533289 100644
--- a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.email/documentation.md
+++ b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.email/documentation.md
@@ -30,7 +30,7 @@ This sink sends an email to a specified receiver.
 
 Before you use this sink, the settings of your email server need to be configured.
 After you've installed the element, navigate to ``Settings``, open the panel ``Sinks Notifications JVM`` and add your
- mail server and credentials.
+mail server and credentials.
 
 ***
 
@@ -56,6 +56,12 @@ The subject of the email.
 
 The mail text.
 
+### Silent Period
+
+The *Silent Period* is the duration, expressed in minutes, during which notifications are temporarily disabled after one
+has been sent. This feature is implemented to prevent overwhelming the target with frequent notifications, avoiding
+potential spam behavior.
+
 ## Output
 
 (not applicable for data sinks)
\ No newline at end of file
diff --git a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.msteams/documentation.md b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.msteams/documentation.md
index b97aec9c4..3c6d41d4f 100644
--- a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.msteams/documentation.md
+++ b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.msteams/documentation.md
@@ -57,6 +57,12 @@ You can choose between two message content formats:
 
 Choose the format that best suits your messaging needs.
 
+### Silent Period
+
+The *Silent Period* is the duration, expressed in minutes, during which notifications are temporarily disabled after one
+has been sent. This feature is implemented to prevent overwhelming the target with frequent notifications, avoiding
+potential spam behavior.
+
 ---
 
 ## Usage
diff --git a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.onesignal/documentation.md b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.onesignal/documentation.md
index 50b031288..017916590 100644
--- a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.onesignal/documentation.md
+++ b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.onesignal/documentation.md
@@ -52,6 +52,12 @@ The OneSignal API key.
 
 The message that should be sent to OneSignal
 
+### Silent Period
+
+The *Silent Period* is the duration, expressed in minutes, during which notifications are temporarily disabled after one
+has been sent. This feature is implemented to prevent overwhelming the target with frequent notifications, avoiding
+potential spam behavior.
+
 ## Output
 
 (not applicable for data sinks)
\ No newline at end of file
diff --git a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.slack/documentation.md b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.slack/documentation.md
index 78095ef61..a53cb3b5c 100644
--- a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.slack/documentation.md
+++ b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.slack/documentation.md
@@ -55,6 +55,11 @@ The channel type, should be "User" or "Channel"
 
 The message that should be sent.
 
+### Silent Period
+
+The *Silent Period* is the duration, expressed in minutes, during which notifications are temporarily disabled after one
+has been sent. This feature is implemented to prevent overwhelming the target with frequent notifications, avoiding
+potential spam behavior.
 
 ## Output
 
diff --git a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.telegram/documentation.md b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.telegram/documentation.md
index 6d1f4675a..fa4d08ef0 100644
--- a/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.telegram/documentation.md
+++ b/streampipes-extensions/streampipes-sinks-notifications-jvm/src/main/resources/org.apache.streampipes.sinks.notifications.jvm.telegram/documentation.md
@@ -59,6 +59,12 @@ The handle name of your public channel (e.g. `@channel_name`).
 
 The message to be sent.
 
+### Silent Period
+
+The *Silent Period* is the duration, expressed in minutes, during which notifications are temporarily disabled after one
+has been sent. This feature is implemented to prevent overwhelming the target with frequent notifications, avoiding
+potential spam behavior.
+
 ## Output
 
 (not applicable for data sinks)