sheppy/opendesk
1
0
Fork 0
mirror of https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git synced 2025-12-06 07:21:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Update ToC across MD files and document Nubus version bump in README.md

Browse Source
This commit is contained in:
Thorsten Roßner
2025-03-27 07:43:59 +01:00
parent 04efd54022
commit c37eedba42
8 changed files with 28 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -33,14 +33,14 @@ For production use the [openDesk Enterprise Edition](./README-EE.md) is required
openDesk currently features the following functional main components:
| Function | Functional Component | Component<br/>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) |
| 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/) |

4
docs/architecture/apis.md
View File

@@ -7,6 +7,7 @@ SPDX-License-Identifier: Apache-2.0
This chapter presents APIs available in openDesk grouped by applications.
<!-- TOC -->
* [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)
<!-- TOC -->
# IAM - Nubus

1
docs/enhanced-configuration/matrix-federation.md
View File

@@ -6,7 +6,6 @@ SPDX-License-Identifier: Apache-2.0
<h1>Matrix federation</h1>
<!-- TOC -->
* [Context](#context)
* [Example configuration](#example-configuration)
* [Disable federation](#disable-federation)
* [Separate Matrix domain](#separate-matrix-domain)

1
docs/enhanced-configuration/separate-mail-matrix-domain.md
View File

@@ -6,7 +6,6 @@ SPDX-License-Identifier: Apache-2.0
<h1>Separate domains for mail and or Matrix </h1>
<!-- TOC -->
* [Context](#context)
* [Example configuration](#example-configuration)
* [Mail domain](#mail-domain)
* [Matrix domain](#matrix-domain)

5
docs/functional.md
View File

@@ -7,6 +7,11 @@ SPDX-License-Identifier: Apache-2.0
This document addresses the available functional configuration options of an openDesk deployment.
<!-- TOC -->
* [Supported functional configuration](#supported-functional-configuration)
* [Customization of functional options](#customization-of-functional-options)
<!-- TOC -->
## 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)

2
docs/getting-started.md
View File

@@ -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)

6
docs/migrations.md
View File

@@ -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)

2
docs/monitoring.md
View File

@@ -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)
<!-- TOC -->
# Technology