From da884cb0c0fc16cb344c46f890b8ca4066c2adfd Mon Sep 17 00:00:00 2001 From: kobergj Date: Wed, 6 Sep 2023 10:42:47 +0200 Subject: [PATCH] improve clientlog documentation Co-authored-by: Martin --- services/clientlog/README.md | 18 +++++++++--------- services/sse/README.md | 10 +++++----- services/userlog/README.md | 10 +++++----- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/services/clientlog/README.md b/services/clientlog/README.md index 9421f5b3bd4..b00bccc8e4b 100644 --- a/services/clientlog/README.md +++ b/services/clientlog/README.md @@ -1,14 +1,14 @@ -# Clientlog service +# Clientlog Service -The `clientlog` service is responsible for composing machine readable notifications for clients +The `clientlog` service is responsible for composing machine readable notifications for clients. Clients are apps and web interfaces. -## The `...log` service ecosystem +## The Log Service Ecosystem -`...log` services (`userlog`, `clientlog`) are responsible for composing notifications for a certain audience. - - `userlog` service translates and adjust messages to be human readable - - `clientlog` service composes machine readable messages so clients can act without needing to query the server - - `sse` service is only responsible for sending these messages. It does not care about their form or language +Log services like the `userlog`, `clientlog` and `sse` are responsible for composing notifications for a certain audience. + - The `userlog` service translates and adjusts messages to be human readable. + - The `clientlog` service composes machine readable messages, so clients can act without the need to query the server. + - The `sse` service is only responsible for sending these messages. It does not care about their form or language. -## `clientlog` events +## Clientlog Events -The messages the `clientlog` service sends are meant to be used by clients, not by users. The client might for example be informed that a file is finished postprocessing, so it can make the file available to the user without needing to make another call to the server. +The messages the `clientlog` service sends are intended for the use by clients, not by users. The client might for example be informed that a file has finished post-processing. With that, the client can make the file available to the user without additional server queries. diff --git a/services/sse/README.md b/services/sse/README.md index 332d052dd0b..11e47b7c9eb 100644 --- a/services/sse/README.md +++ b/services/sse/README.md @@ -2,12 +2,12 @@ The `sse` service is responsible for sending sse (Server-Sent Events) to a user. See [What is Server-Sent Events](https://medium.com/yemeksepeti-teknoloji/what-is-server-sent-events-sse-and-how-to-implement-it-904938bffd73) for a simple introduction and examples of server sent events. -## The `...log` service ecosystem +## The Log Service Ecosystem -`...log` services (`userlog`, `clientlog`) are responsible for composing notifications for a certain audience. - - `userlog` service translates and adjust messages to be human readable - - `clientlog` service composes machine readable messages so clients can act without needing to query the server - - `sse` service is only responsible for sending these messages. It does not care about their form or language +Log services like the `userlog`, `clientlog` and `sse` are responsible for composing notifications for a certain audience. + - The `userlog` service translates and adjusts messages to be human readable. + - The `clientlog` service composes machine readable messages, so clients can act without the need to query the server. + - The `sse` service is only responsible for sending these messages. It does not care about their form or language. ## Subscribing diff --git a/services/userlog/README.md b/services/userlog/README.md index e89e1dbc5f7..0261b2ceea5 100644 --- a/services/userlog/README.md +++ b/services/userlog/README.md @@ -2,12 +2,12 @@ The `userlog` service is a mediator between the `eventhistory` service and clients who want to be informed about user related events. It provides an API to retrieve those. -## The `...log` service ecosystem +## The Log Service Ecosystem -`...log` services (`userlog`, `clientlog`) are responsible for composing notifications for a certain audience. - - `userlog` service translates and adjust messages to be human readable - - `clientlog` service composes machine readable messages so clients can act without needing to query the server - - `sse` service is only responsible for sending these messages. It does not care about their form or language +Log services like the `userlog`, `clientlog` and `sse` are responsible for composing notifications for a certain audience. + - The `userlog` service translates and adjusts messages to be human readable. + - The `clientlog` service composes machine readable messages, so clients can act without the need to query the server. + - The `sse` service is only responsible for sending these messages. It does not care about their form or language. ## Prerequisites