mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-02-13 07:35:08 -06:00
Code Issues Packages Projects Releases Wiki Activity

improve clientlog documentation

Browse Source 
Co-authored-by: Martin <github@diemattels.at>
This commit is contained in:
kobergj
2023-09-06 10:42:47 +02:00
committed by jkoberg
parent 74f4143f0b
commit da3f975d87
3 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
services/clientlog/README.md
View File

@@ -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
services/sse/README.md
View File

@@ -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

10
services/userlog/README.md
View File

@@ -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