Skip to content
This repository was archived by the owner on Aug 19, 2026. It is now read-only.

Commit 1997ecc

Browse files
dj4oCdj4oC
committed
docs(ospo): community health rollout v2 — README, agents.md, health files
Introduced by the Kiteworks Open Source Program Office (OSPO) on May 5, 2026. Changes: - README.md: rewritten with OSPO v2 template — license-specific migration guidance, Community & Support section, Contributing workflow, Security section pointing to security.owncloud.com + YesWeHack bug bounty - agents.md: AI agent context file with architecture, build commands, and OSPO Policy Constraints (GitHub Actions, Dependabot, Git Workflow) - CODE_OF_CONDUCT.md: redirect to https://owncloud.com/contribute/code-of-conduct/ - CONTRIBUTING.md: redirect to https://owncloud.com/contribute/ - SECURITY.md: redirect to https://security.owncloud.com + YesWeHack - SUPPORT.md: redirect to https://owncloud.com/contact-us/ + channels OSPO: https://kiteworks.com/opensource Signed-off-by: David Walter <david.walter@kiteworks.com>
1 parent 558c5f0 commit 1997ecc

6 files changed

Lines changed: 186 additions & 23 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Code of Conduct
2+
3+
This project follows the ownCloud Code of Conduct.
4+
5+
Please read the full Code of Conduct at:
6+
**<https://owncloud.com/contribute/code-of-conduct/>**
7+
8+
By participating in this project, you agree to abide by its terms.

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to this project!
4+
5+
Please read the full contributing guidelines at:
6+
**<https://owncloud.com/contribute/>**
7+
8+
For development setup, coding standards, and pull request process,
9+
see the README in this repository.

‎README.md‎

Lines changed: 81 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,99 @@
1-
# ownCloud Web User Interface
1+
# ownCloud Web UI Documentation
22

3-
**IMPORTANT**
3+
<!-- OSPO-managed README | Generated: 2026-04-16 | v2 -->
44

5-
Since April 2026, this repository requires [Commit Signing](https://docs.github.com/articles/about-gpg) and uses [Conventional Commits](https://www.conventionalcommits.org) for commits and the Pull Request title.
5+
[![License](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE) [![ownCloud OSPO](https://img.shields.io/badge/OSPO-ownCloud-blue)](https://kiteworks.com/opensource)
66

7-
**Table of Contents**
7+
Antora-based documentation component for the ownCloud Web user interface. This repository contains the AsciiDoc source files covering configuration and usage of the ownCloud Web frontend, published as part of the documentation site at [doc.owncloud.com](https://doc.owncloud.com).
88

9-
* [Building the Web User Interface Docs](#building-the-web-user-interface-docs)
10-
* [General Notes](#general-notes)
11-
* [Generating the Documentation](#generating-the-documentation)
12-
* [Target Branch and Backporting](#target-branch-and-backporting)
13-
* [Branching Workflow](#branching-workflow)
14-
* [Create a New Version Branch for Web User Interfaces](#create-a-new-version-branch-for-web-user-interfaces)
9+
## Getting Started
1510

11+
To preview changes locally:
1612

17-
## Building the Web User Interface Docs
13+
```bash
14+
npm install
15+
npm run antora-local
16+
npm run serve
17+
```
1818

19-
The ownCloud Web User Interface Guides are not built independently. Instead, it is built together with the [main documentation](https://github.com/owncloud/docs/). However, you can build a local copy of the ownCloud Server documentation to preview changes you are making.
19+
This generates a standalone preview at `http://localhost:8080`. For the full site build, merge your changes and the [docs](https://github.com/owncloud/docs) repository will automatically rebuild.
2020

21-
Whenever a Pull Request of this repo gets merged, it automatically triggers a full docs build.
21+
## Documentation
2222

23-
## General Notes
23+
- [Branching Workflow](https://github.com/owncloud/docs-webui/blob/master/docs/the-branching-workflow.md)
24+
- [Main Documentation Build](https://github.com/owncloud/docs)
2425

25-
To make life easier, most of the content written in [docs](https://github.com/owncloud/docs#readme) applies also here. For ease of reading, the most important steps are documented here too. For more information see the link provided. Only a few topics of this repo are unique like the branching.
26+
## Part of ownCloud Documentation
2627

27-
## Generating the Documentation
28+
This is a content component for the [ownCloud docs](https://github.com/owncloud/docs) Antora build. Published documentation is available at [doc.owncloud.com](https://doc.owncloud.com).
2829

29-
See the [Generating the Documentation](https://github.com/owncloud/docs#generating-the-documentation) in the docs repo for more details as it applies to all documentation repositories.
30+
## Community & Support
3031

31-
## Target Branch and Backporting
32+
**[Star](https://github.com/owncloud/docs-webui)** this repo and **Watch** for release notifications!
3233

33-
See the [following section](https://github.com/owncloud/docs#target-branch-and-backporting) as the same rules and notes apply.
34+
- [ownCloud Website](https://owncloud.com)
35+
- [Community Discussions](https://github.com/orgs/owncloud/discussions)
36+
- [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org)
37+
- [Documentation](https://doc.owncloud.com)
38+
- [Enterprise Support](https://owncloud.com/contact-us/)
39+
- [OSPO Home](https://kiteworks.com/opensource)
3440

35-
## Branching Workflow
41+
## Contributing
3642

37-
Please refer to the [Branching Workflow for ownCloud Server](https://github.com/owncloud/docs-webui/blob/master/docs/the-branching-workflow.md) for more information.
43+
We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md)
44+
and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started.
3845

39-
## Create a New Version Branch for Web User Interfaces
46+
### Workflow
4047

41-
Please refer to [Create a New Version Branch for Web User Interfaces](https://github.com/owncloud/docs-webui/blob/master/docs/new-version-branch.md) for more information.
48+
- **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR.
49+
- **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly.
50+
- **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification).
51+
- **DCO Sign-off**: Every commit must carry a `Signed-off-by` line:
52+
```
53+
git commit -s -S -m "your commit message"
54+
```
55+
- **GitHub Actions Policy**: Workflows may only use actions that are (a) owned by `owncloud`, (b) created by GitHub (`actions/*`), or (c) verified in the GitHub Marketplace.
56+
57+
## Security
58+
59+
**Do not open a public GitHub issue for security vulnerabilities.**
60+
61+
Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md).
62+
63+
Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program)
64+
65+
## License
66+
67+
This project is licensed under the [AGPL-3.0](LICENSE).
68+
69+
## About the ownCloud OSPO
70+
71+
The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under
72+
the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source
73+
ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance,
74+
community health, and sustainable collaboration between the open source community and
75+
[Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023.
76+
77+
- **OSPO Home**: <https://kiteworks.com/opensource>
78+
- **GitHub**: <https://github.com/owncloud>
79+
- **ownCloud**: <https://owncloud.com>
80+
81+
For questions about the OSPO or licensing, contact ospo@kiteworks.com.
82+
83+
### License Migration to Apache 2.0
84+
85+
The OSPO is driving a strategic relicensing of ownCloud repositories toward the
86+
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following
87+
the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html).
88+
89+
Individual repositories will migrate as their audit is completed. The LICENSE file
90+
in each repo reflects its **current** license status (not the target).
91+
92+
**Current license: AGPL-3.0** (Category X per Apache policy -- cannot be included in Apache-2.0 works).
93+
94+
Migration prerequisites for this repository:
95+
96+
- **CLA/DCO coverage**: All past contributors must have signed agreements permitting relicensing
97+
- **Copyleft dependency audit**: All AGPL/GPL dependencies must be replaced or isolated
98+
- **KDE heritage review**: Any code with KDE-era copyrights requires legal analysis
99+
- **Complete relicensing**: AGPL-3.0 is a strong copyleft license; migration requires full relicensing of all files, not just a header change

‎SECURITY.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
**Do NOT open a public GitHub issue for security vulnerabilities.**
6+
7+
Please report security issues responsibly via:
8+
**<https://security.owncloud.com>**
9+
10+
You can also report vulnerabilities through our YesWeHack bug bounty program:
11+
**<https://yeswehack.com/programs/owncloud-bug-bounty-program>**

‎SUPPORT.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Support
2+
3+
For support with this project, please use the following channels:
4+
5+
- **Enterprise Support**: <https://owncloud.com/contact-us/>
6+
- **Community discussions**: https://github.com/orgs/owncloud/discussions
7+
- **Matrix Chat**: <https://app.element.io/#/room/#owncloud:matrix.org>
8+
- **Documentation**: <https://doc.owncloud.com>
9+
10+
Please do not use GitHub issues for general support questions.

‎agents.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# AI Agent Guidelines for ownCloud Web UI Documentation
2+
3+
This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cursor, etc.) working in this repository.
4+
5+
## Repository Overview
6+
- **Product family:** Documentation
7+
- **Primary language(s):** JavaScript
8+
- **Build system:** npm (Antora)
9+
- **Test framework:** broken-link-checker
10+
- **CI system:** GitHub Actions
11+
12+
## Architecture & Key Paths
13+
14+
- `antora.yml` -- Antora component descriptor
15+
- `modules/` -- AsciiDoc documentation content modules
16+
- `site.yml` -- Standalone site playbook for local preview
17+
- `package.json` -- npm scripts
18+
- `ext-antora/` -- Custom Antora extensions
19+
- `ext-asciidoc/` -- Custom AsciiDoc extensions
20+
21+
## Development Conventions
22+
- **Branching:** master
23+
- **Commit messages:** DCO sign-off required (`git commit -s`)
24+
- **Code style:** Prettier (for formatting)
25+
- **PR process:** Open a PR against `master`. All CI checks must pass.
26+
27+
## Build & Test Commands
28+
```bash
29+
# Build
30+
npm run antora
31+
32+
# Test
33+
npm run linkcheck
34+
35+
# Lint
36+
Not detected (Prettier config present for formatting)
37+
```
38+
39+
## Important Constraints
40+
- All code contributions must be compatible with the **AGPL-3.0** license
41+
- Do not introduce new **copyleft-licensed dependencies** (GPL, AGPL, LGPL, MPL) without explicit discussion in an issue first. This is especially important for repos migrating to Apache 2.0.
42+
- Do not introduce new dependencies without discussion in an issue first
43+
44+
45+
## OSPO Policy Constraints
46+
47+
### GitHub Actions
48+
- **Only** use actions owned by `owncloud`, created by GitHub (`actions/*`), verified on the GitHub Marketplace, or verified by the ownCloud Maintainers.
49+
- Pin all actions to their full commit SHA (not tags): `uses: actions/checkout@<SHA> # vX.Y.Z`
50+
- Never introduce actions from unverified third parties.
51+
52+
### Dependency Management
53+
- Dependabot is configured for automated dependency updates.
54+
- Review and merge Dependabot PRs as part of regular maintenance.
55+
- Do not introduce new dependencies without discussion in an issue first.
56+
57+
### Git Workflow
58+
- **Rebase policy**: Always rebase; never create merge commits. Use `git pull --rebase` and `git rebase` before pushing.
59+
- **Signed commits**: All commits **must** be PGP/GPG signed (`git commit -S -s`).
60+
- **DCO sign-off**: Every commit needs a `Signed-off-by` line (`git commit -s`).
61+
- **Conventional Commits & Squash Merge**: Use the [Conventional Commits](https://www.conventionalcommits.org/) format where the repository enforces it. Many repos use squash merge, where the PR title becomes the commit message on the default branch — apply Conventional Commits format to PR titles as well. A reusable GitHub Actions workflow enforces this.
62+
63+
## Context for AI Agents
64+
- Match existing code style
65+
- Do not refactor unrelated code in the same PR
66+
- Write tests for new functionality
67+
- Keep PRs focused and atomic

0 commit comments

Comments
 (0)