Skip to content

Conversation

@schweigisito
Copy link
Contributor

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-generatoranddocs` build run

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added
  • Documentation added

@schweigisito schweigisito self-assigned this Nov 14, 2025
@schweigisito schweigisito requested a review from Copilot November 14, 2025 11:29
Copy link

Copilot AI left a 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.

@github-project-automation github-project-automation bot moved this to Qualification in OpenCloud Team Board Nov 14, 2025
@schweigisito schweigisito requested a review from micbar November 14, 2025 11:30
@db-ot db-ot moved this from Qualification to In Progress in OpenCloud Team Board Nov 17, 2025
Copy link
Contributor

@butonic butonic left a 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

butonic and others added 2 commits November 17, 2025 10:41
Co-authored-by: Jörn Friedrich Dreyer <jfd@butonic.de>
@schweigisito schweigisito merged commit 6161e40 into main Nov 19, 2025
57 of 58 checks passed
@schweigisito schweigisito deleted the fix/create-missing-readme-files branch November 19, 2025 18:16
@github-project-automation github-project-automation bot moved this from In Progress to Done in OpenCloud Team Board Nov 19, 2025
@openclouders openclouders mentioned this pull request Nov 19, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants