|
1 | | -# ownCloud Docs — Monorepo (experimental) |
| 1 | +# ownCloud Documentation |
| 2 | + |
| 3 | +<!-- OSPO-managed README | Generated: 2026-08-21 | v2 --> |
| 4 | + |
| 5 | +[](LICENSE) [](https://kiteworks.com/opensource) |
2 | 6 |
|
3 | 7 | Consolidated, single-repository prototype of the ownCloud documentation. It |
4 | 8 | replaces the previous 9-repo setup (1 orchestrator + 7 content repos + a custom |
5 | 9 | UI repo) with **one monorepo** built by Antora. |
6 | 10 |
|
7 | | -Live (GitHub Pages): https://deepdiver1975.github.io/owncloud-docs-monorepo/ |
| 11 | +Live (GitHub Pages): https://doc.owncloud.com |
8 | 12 |
|
9 | 13 | ## What changed vs. the legacy setup |
10 | 14 |
|
11 | 15 | | Area | Legacy | Here | |
12 | 16 | |------|--------|------| |
13 | 17 | | Repos | 9 | 1 (this repo) | |
14 | 18 | | Versions | git branches + backporting | **folders** under `content/<product>/<version>/` | |
15 | | -| Branch model | `master` + N version branches per repo | `master` only | |
| 19 | +| Branch model | `master` + N version branches per repo | `main` only | |
16 | 20 | | Search | Elasticsearch + custom index extension + CI secrets | **Pagefind** (static, build-time) | |
17 | 21 | | UI | custom Gulp/Browserify/jQuery `docs-ui` + `ui-bundle.zip` | **stock Antora default UI** + `ui/supplemental/` | |
18 | 22 | | Content sources | 7 remote GitHub repos × branches | local folders, authored here (upstream mirror retired) | |
@@ -164,3 +168,74 @@ npm run serve # http-server on :8080 |
164 | 168 | ``` |
165 | 169 |
|
166 | 170 | Node 22 is recommended (matches CI). |
| 171 | + |
| 172 | +## Community & Support |
| 173 | + |
| 174 | +**[Star](https://github.com/owncloud/docs.owncloud.com)** this repo and **Watch** for release notifications! |
| 175 | + |
| 176 | +- [ownCloud Website](https://owncloud.com) |
| 177 | +- [Community Discussions](https://github.com/orgs/owncloud/discussions) |
| 178 | +- [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org) |
| 179 | +- [Documentation](https://doc.owncloud.com) |
| 180 | +- [Enterprise Support](https://owncloud.com/contact-us/) |
| 181 | +- [OSPO Home](https://kiteworks.com/opensource) |
| 182 | + |
| 183 | +## Contributing |
| 184 | + |
| 185 | +We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md) |
| 186 | +and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started. |
| 187 | + |
| 188 | +### Workflow |
| 189 | + |
| 190 | +- **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR. |
| 191 | +- **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly. |
| 192 | +- **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification). |
| 193 | +- **DCO Sign-off**: Every commit must carry a `Signed-off-by` line: |
| 194 | + ``` |
| 195 | + git commit -s -S -m "your commit message" |
| 196 | + ``` |
| 197 | +- **GitHub Actions Policy**: Workflows may only use actions that are (a) owned by `owncloud`, (b) created by GitHub (`actions/*`), (c) verified in the GitHub Marketplace, or (d) verified by the ownCloud Maintainers. Pin every action to its full commit SHA. |
| 198 | + |
| 199 | +## Security |
| 200 | + |
| 201 | +**Do not open a public GitHub issue for security vulnerabilities.** |
| 202 | + |
| 203 | +Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md). |
| 204 | + |
| 205 | +Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program) |
| 206 | + |
| 207 | +## License |
| 208 | + |
| 209 | +This project is licensed under the [AGPL-3.0](LICENSE). |
| 210 | + |
| 211 | +## About the ownCloud OSPO |
| 212 | + |
| 213 | +The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under |
| 214 | +the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source |
| 215 | +ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance, |
| 216 | +community health, and sustainable collaboration between the open source community and |
| 217 | +[Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023. |
| 218 | + |
| 219 | +- **OSPO Home**: <https://kiteworks.com/opensource> |
| 220 | +- **GitHub**: <https://github.com/owncloud> |
| 221 | +- **ownCloud**: <https://owncloud.com> |
| 222 | + |
| 223 | +For questions about the OSPO or licensing, contact ospo@kiteworks.com. |
| 224 | + |
| 225 | +### License Migration to Apache 2.0 |
| 226 | + |
| 227 | +The OSPO is driving a strategic relicensing of ownCloud repositories toward the |
| 228 | +[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following |
| 229 | +the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html). |
| 230 | + |
| 231 | +Individual repositories will migrate as their audit is completed. The LICENSE file |
| 232 | +in each repo reflects its **current** license status (not the target). |
| 233 | + |
| 234 | +**Current license: AGPL-3.0** (Category X per Apache policy -- cannot be included in Apache-2.0 works). |
| 235 | + |
| 236 | +Migration prerequisites for this repository: |
| 237 | + |
| 238 | +- **CLA/DCO coverage**: All past contributors must have signed agreements permitting relicensing |
| 239 | +- **Copyleft dependency audit**: All AGPL/GPL dependencies must be replaced or isolated |
| 240 | +- **KDE heritage review**: Any code with KDE-era copyrights requires legal analysis |
| 241 | +- **Complete relicensing**: AGPL-3.0 is a strong copyleft license; migration requires full relicensing of all files, not just a header change |
0 commit comments