Skip to content

Commit

Permalink
improve clientlog documentation
Browse files Browse the repository at this point in the history
Co-authored-by: Martin <github@diemattels.at>
  • Loading branch information
kobergj and mmattel committed Sep 6, 2023
1 parent 4f0d53e commit da884cb
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
18 changes: 9 additions & 9 deletions services/clientlog/README.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 5 additions & 5 deletions services/sse/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 5 additions & 5 deletions services/userlog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit da884cb

Please sign in to comment.