From 4de25fdb5e8c24aa65ac71a2304863ef105d8fc3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= Date: Mon, 17 Nov 2025 10:41:17 +0100 Subject: [PATCH] Apply suggestions from code review --- services/app-provider/README.md | 2 +- services/groups/README.md | 2 +- services/storage-publiclink/README.md | 9 +++------ services/storage-shares/README.md | 9 +++------ services/users/README.md | 2 +- 5 files changed, 9 insertions(+), 15 deletions(-) diff --git a/services/app-provider/README.md b/services/app-provider/README.md index 4d68bd31e9..26354be495 100644 --- a/services/app-provider/README.md +++ b/services/app-provider/README.md @@ -18,4 +18,4 @@ The service can be configured via environment variables. Key configuration optio ## Scalability -The app-provider service can be scaled horizontally as it primarily acts as a coordinator between applications and the OpenCloud storage layer. +The app-provider service can be scaled horizontally as it primarily acts as a coordinator between applications and the OpenCloud backend services. diff --git a/services/groups/README.md b/services/groups/README.md index 7d496a7ff0..7f22e11807 100644 --- a/services/groups/README.md +++ b/services/groups/README.md @@ -22,7 +22,7 @@ The service provides CS3 gRPC APIs for: ## Usage -The groups service is primarily used internally by other OpenCloud services rather than being accessed directly by clients. The `frontend` and `ocs` services translate HTTP API requests into CS3 API calls to this service. +The groups service is only used internally by other OpenCloud services and not being accessed directly by clients. The `frontend` and `ocs` services translate HTTP API requests into CS3 API calls to this service. ## Scalability diff --git a/services/storage-publiclink/README.md b/services/storage-publiclink/README.md index d6640894a9..8728743bbf 100644 --- a/services/storage-publiclink/README.md +++ b/services/storage-publiclink/README.md @@ -1,20 +1,17 @@ # Storage PublicLink -The `storage-publiclink` service provides storage backend functionality for public link shares in OpenCloud. It implements the CS3 storage provider interface specifically for managing public link shared resources. +The `storage-publiclink` service provides storage backend functionality for public link shares in OpenCloud. It implements the CS3 storage provider interface specifically for working with public link shared resources. ## Overview This service is part of the storage services family and is responsible for: -- Storing metadata about public link shares - Providing access to publicly shared resources -- Managing public link tokens and permissions - Handling anonymous access to shared content ## Integration The storage-publiclink service integrates with: -- `sharing` service - Creates and manages public link shares -- `gateway` service - Routes requests to publicly shared resources +- `sharing` service - Manages and persists public link shares - `frontend` and `ocdav` - Provide HTTP/WebDAV access to public links - Storage drivers - Accesses the actual file content @@ -37,4 +34,4 @@ Public link shares can be configured with: ## Scalability -The storage-publiclink service can be scaled horizontally. When running multiple instances, ensure that the storage backend configuration is identical across all instances. +The storage-publiclink service can be scaled horizontally. diff --git a/services/storage-shares/README.md b/services/storage-shares/README.md index 1527c9a442..5686b5a9e6 100644 --- a/services/storage-shares/README.md +++ b/services/storage-shares/README.md @@ -1,20 +1,17 @@ # Storage Shares -The `storage-shares` service provides storage backend functionality for user and group shares in OpenCloud. It implements the CS3 storage provider interface specifically for managing shared resources. +The `storage-shares` service provides storage backend functionality for user and group shares in OpenCloud. It implements the CS3 storage provider interface specifically for working with shared resources. ## Overview This service is part of the storage services family and is responsible for: -- Storing metadata about user and group shares - Providing a virtual view of received shares -- Managing share mountpoints - Handling access to resources shared by other users ## Integration The storage-shares service integrates with: -- `sharing` service - Creates and manages shares -- `gateway` service - Routes requests to shared resources +- `sharing` service - Manages and persists shares - `storage-users` service - Accesses the underlying file content - `frontend` and `ocdav` - Provide HTTP/WebDAV access to shares @@ -33,4 +30,4 @@ See the `gateway` README for more details on storage registry configuration. ## Scalability -The storage-shares service can be scaled horizontally. When running multiple instances, ensure that the share metadata storage configuration is identical across all instances. +The storage-shares service can be scaled horizontally. diff --git a/services/users/README.md b/services/users/README.md index 04ec3a1ece..4d06667f54 100644 --- a/services/users/README.md +++ b/services/users/README.md @@ -22,7 +22,7 @@ The service provides CS3 gRPC APIs for: ## Usage -The users service is primarily used internally by other OpenCloud services rather than being accessed directly by clients. The `frontend`, `ocs`, and `graph` services translate HTTP API requests into CS3 API calls to this service. +The users service is only used internally by other OpenCloud services and not being accessed directly by clients. The `frontend`, `ocs`, and `graph` services translate HTTP API requests into CS3 API calls to this service. ## Scalability