-
Notifications
You must be signed in to change notification settings - Fork 157
fix: add missing service README.md files with basic description #1859
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds missing README.md files to several OpenCloud services to resolve documentation build pipeline failures caused by broken links. Each README provides a basic description of the service's purpose, integration points, and scalability characteristics.
- Adds comprehensive README.md files for six services (users, storage-shares, storage-publiclink, sharing, groups, app-provider)
- Documents CS3 API implementations and backend integrations
- Includes service-specific configuration and scalability information
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| services/users/README.md | Documents the CS3 Users API service for managing user information and authentication |
| services/storage-shares/README.md | Documents the storage backend for user and group shares with virtual shares folder |
| services/storage-publiclink/README.md | Documents the storage backend for public link shares and anonymous access |
| services/sharing/README.md | Documents the CS3 Sharing API for managing user and public link shares |
| services/groups/README.md | Documents the CS3 Groups API service for managing groups and memberships |
| services/app-provider/README.md | Documents the CS3 App Provider API for managing file-opening applications |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
butonic
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice, but some things not quite accurate
Co-authored-by: Jörn Friedrich Dreyer <jfd@butonic.de>
Description
Add missing README.md files, including some basic servcie description, to some of the affected services
Motivation and Context
docs build pipeline fails because of missing files, therefore missing links within the docs files.
How Has This Been Tested?
Not yet, will be tested with a next 'markdown-docs-generator
anddocs` build runScreenshots (if appropriate):
Types of changes
Checklist: