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

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

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

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)

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)

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)
@@ -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<br>**
> 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.

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)

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)

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