From c37eedba42ffbe1f9f2b4f7a9cd478accf0cbb6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thorsten=20Ro=C3=9Fner?= Date: Thu, 27 Mar 2025 07:43:59 +0100 Subject: [PATCH] chore(docs): Update ToC across MD files and document Nubus version bump in `README.md` --- README.md | 24 +++++++++---------- docs/architecture/apis.md | 4 +++- .../matrix-federation.md | 1 - .../separate-mail-matrix-domain.md | 1 - docs/functional.md | 7 +++++- docs/getting-started.md | 2 -- docs/migrations.md | 6 +++++ docs/monitoring.md | 2 +- 8 files changed, 28 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 7fe936a2..cb9f3f98 100644 --- a/README.md +++ b/README.md @@ -32,18 +32,18 @@ For production use the [openDesk Enterprise Edition](./README-EE.md) is required openDesk currently features the following functional main components: -| Function | Functional Component | Component
Version | Upstream Documentation | -| -------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| Chat & collaboration | Element ft. Nordeck widgets | [1.11.89](https://github.com/element-hq/element-desktop/releases/tag/v1.11.89) | [For the most recent release](https://element.io/user-guide) | -| Collaborative notes | Notes (aka Docs) | [2.4.0](https://github.com/suitenumerique/docs/releases/tag/v2.4.0) | Online documentation/welcome document available in installed application | -| Diagram editor | CryptPad ft. diagrams.net | [2024.9.0](https://github.com/cryptpad/cryptpad/releases/tag/2024.9.0) | [For the most recent release](https://docs.cryptpad.org/en/) | -| File management | Nextcloud | [30.0.6](https://nextcloud.com/de/changelog/#30-0-6) | [Nextcloud 30](https://docs.nextcloud.com/) | -| Groupware | OX App Suite | [8.35](https://documentation.open-xchange.com/appsuite/releases/8.35/) | Online documentation available from within the installed application; [Additional resources](https://documentation.open-xchange.com/) | -| Knowledge management | XWiki | [16.10.5](https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/16.10.5/) | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation) | -| Portal & IAM | Nubus | [1.5.1](https://docs.software-univention.de/nubus-kubernetes-release-notes/latest/en/changelog.html) | [Univention's documentation website](https://docs.software-univention.de/n/en/nubus.html) | -| Project management | OpenProject | [15.4.1](https://www.openproject.org/docs/release-notes/15-4-1/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) | -| Videoconferencing | Jitsi | [2.0.9955](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9955) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/user-guide/) | -| Weboffice | Collabora | [24.04.12.4](https://www.collaboraoffice.com/code-24-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) | +| Function | Functional Component | Component
Version | Upstream Documentation | +|----------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Chat & collaboration | Element ft. Nordeck widgets | [1.11.89](https://github.com/element-hq/element-desktop/releases/tag/v1.11.89) | [For the most recent release](https://element.io/user-guide) | +| Collaborative notes | Notes (aka Docs) | [2.4.0](https://github.com/suitenumerique/docs/releases/tag/v2.4.0) | Online documentation/welcome document available in installed application | +| Diagram editor | CryptPad ft. diagrams.net | [2024.9.0](https://github.com/cryptpad/cryptpad/releases/tag/2024.9.0) | [For the most recent release](https://docs.cryptpad.org/en/) | +| File management | Nextcloud | [30.0.6](https://nextcloud.com/de/changelog/#30-0-6) | [Nextcloud 30](https://docs.nextcloud.com/) | +| Groupware | OX App Suite | [8.35](https://documentation.open-xchange.com/appsuite/releases/8.35/) | Online documentation available from within the installed application; [Additional resources](https://documentation.open-xchange.com/) | +| Knowledge management | XWiki | [16.10.5](https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/16.10.5/) | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation) | +| Portal & IAM | Nubus | [1.7.0](https://docs.software-univention.de/nubus-kubernetes-release-notes/latest/en/changelog.html#version-1-7-0-2025-02-23) | [Univention's documentation website](https://docs.software-univention.de/n/en/nubus.html) | +| Project management | OpenProject | [15.4.1](https://www.openproject.org/docs/release-notes/15-4-1/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) | +| Videoconferencing | Jitsi | [2.0.9955](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9955) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/user-guide/) | +| Weboffice | Collabora | [24.04.12.4](https://www.collaboraoffice.com/code-24-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) | While not all components are perfectly shaped for the execution inside containers, one of the project's objectives is to align the applications with best practices regarding container design and operations. diff --git a/docs/architecture/apis.md b/docs/architecture/apis.md index ada21a15..2673457c 100644 --- a/docs/architecture/apis.md +++ b/docs/architecture/apis.md @@ -7,6 +7,7 @@ SPDX-License-Identifier: Apache-2.0 This chapter presents APIs available in openDesk grouped by applications. + * [IAM - Nubus](#iam---nubus) * [UMC Python API](#umc-python-api) * [UMC store API](#umc-store-api) @@ -43,7 +44,7 @@ This chapter presents APIs available in openDesk grouped by applications. * [BCF API](#bcf-api) * [Video Conferencing - Jitsi](#video-conferencing---jitsi) * [IFrame API](#iframe-api) - * [Lib-jitsi-meet API](#lib-jitsi-meet-api) + * [lib-jitsi-meet API](#lib-jitsi-meet-api) * [Jitsi Meet React SDK](#jitsi-meet-react-sdk) * [Chat - Element](#chat---element) * [Matrix Application Service API](#matrix-application-service-api) @@ -60,6 +61,7 @@ This chapter presents APIs available in openDesk grouped by applications. * [Scripting API](#scripting-api) * [Java API](#java-api) * [JavaScript API](#javascript-api) + # IAM - Nubus diff --git a/docs/enhanced-configuration/matrix-federation.md b/docs/enhanced-configuration/matrix-federation.md index 870aa178..27249371 100644 --- a/docs/enhanced-configuration/matrix-federation.md +++ b/docs/enhanced-configuration/matrix-federation.md @@ -6,7 +6,6 @@ SPDX-License-Identifier: Apache-2.0

Matrix federation

-* [Context](#context) * [Example configuration](#example-configuration) * [Disable federation](#disable-federation) * [Separate Matrix domain](#separate-matrix-domain) diff --git a/docs/enhanced-configuration/separate-mail-matrix-domain.md b/docs/enhanced-configuration/separate-mail-matrix-domain.md index 7a040979..b0528a47 100644 --- a/docs/enhanced-configuration/separate-mail-matrix-domain.md +++ b/docs/enhanced-configuration/separate-mail-matrix-domain.md @@ -6,7 +6,6 @@ SPDX-License-Identifier: Apache-2.0

Separate domains for mail and or Matrix

-* [Context](#context) * [Example configuration](#example-configuration) * [Mail domain](#mail-domain) * [Matrix domain](#matrix-domain) diff --git a/docs/functional.md b/docs/functional.md index 41671825..cc2248e0 100644 --- a/docs/functional.md +++ b/docs/functional.md @@ -7,6 +7,11 @@ SPDX-License-Identifier: Apache-2.0 This document addresses the available functional configuration options of an openDesk deployment. + +* [Supported functional configuration](#supported-functional-configuration) +* [Customization of functional options](#customization-of-functional-options) + + ## Supported functional configuration While the openDesk applications allow a wide range of configuration options, only a small subset of them are supported by openDesk. This subset can be found in [`helmfile/environments/default/functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl) @@ -27,4 +32,4 @@ The following categories are available. Each category contains a set of options In case the options from [`functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl) are not sufficient, you might want to look into [`customization.yaml.gotmpl`](../helmfile/environments/default/customization.yaml.gotmpl). The customizations give you control over all templating that is being done in openDesk, but be aware it is an unsupported approach, so in case you have a strong need for customizations, please let us know by opening a ticket. We will check if it is a use case that can be supported by implementing it as part of the aforementioned [`functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl). > **Note
** -> You can not directly template your own values in the structure found in [`customization.yaml.gotmpl`](../helmfile/environments/default/customization.yaml.gotmpl), rather, you need to reference your custom value files to overwrite the openDesk defaults. In the app specific `helmfile-child.yaml.gotmpl` files, the openDesk value files are referenced first, then afterwards, the files you define in the customizations are read. +> You can not directly template your own values in the structure found in [`customization.yaml.gotmpl`](../helmfile/environments/default/customization.yaml.gotmpl), rather, you need to reference your custom value files to overwrite the openDesk defaults. In the app specific `helmfile-child.yaml.gotmpl` files, the openDesk value files are referenced first, then afterwards, the files you define in the customizations are read. diff --git a/docs/getting-started.md b/docs/getting-started.md index ae260b49..6f1d4470 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -21,8 +21,6 @@ This documentation lets you create an openDesk evaluation instance on your Kuber * [Container runtime](#container-runtime) * [Volumes](#volumes) * [Customize deployment](#customize-deployment) - * [Functional features](#functional-features) - * [Features through Customization](#features-through-customization) * [Connectivity](#connectivity) * [Ports](#ports) * [Web-based user interface](#web-based-user-interface) diff --git a/docs/migrations.md b/docs/migrations.md index 71032d2a..e6b6a9c5 100644 --- a/docs/migrations.md +++ b/docs/migrations.md @@ -9,6 +9,9 @@ SPDX-License-Identifier: Apache-2.0 * [Disclaimer](#disclaimer) * [Automated migrations - Overview and mandatory upgrade path](#automated-migrations---overview-and-mandatory-upgrade-path) * [Manual checks/actions](#manual-checksactions) + * [From v1.1.2](#from-v112) + * [Helmfile cleanup: Do not configure OX provisioning when no OX installed](#helmfile-cleanup-do-not-configure-ox-provisioning-when-no-ox-installed) + * [Helmfile new default: PostgreSQL for XWiki and Nextcloud](#helmfile-new-default-postgresql-for-xwiki-and-nextcloud) * [From v1.1.1](#from-v111) * [Pre-upgrade from v1.1.1](#pre-upgrade-from-v111) * [Helmfile feature update: App settings wrapped in `apps.` element](#helmfile-feature-update-app-settings-wrapped-in-apps-element) @@ -47,6 +50,9 @@ SPDX-License-Identifier: Apache-2.0 * [Updated customizable template attributes](#updated-customizable-template-attributes) * [`migrations` S3 bucket](#migrations-s3-bucket) * [Automated migrations - Details](#automated-migrations---details) + * [From v1.1.2 (automated)](#from-v112-automated) + * [migrations-pre](#migrations-pre) + * [migrations-post](#migrations-post) * [From v1.0.0 (automated)](#from-v100-automated) * [From v0.9.0 (automated)](#from-v090-automated) * [Related components and artifacts](#related-components-and-artifacts) diff --git a/docs/monitoring.md b/docs/monitoring.md index dd289e08..27016104 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -14,7 +14,7 @@ well as the overall status of monitoring integration. * [Metrics](#metrics) * [Alerts](#alerts) * [Dashboards for Grafana](#dashboards-for-grafana) -* [Components](#components) +* [Component overview](#component-overview) # Technology