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

docs(misc): Change to stylized note/warning/important banners

Browse Source
This commit is contained in:
Philip Gaber
2025-11-06 14:02:34 +01:00
parent b2f1d609cb
commit 47e13e4ff9
17 changed files with 131 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/developer/development.md
View File

@@ -84,9 +84,9 @@ In the project's CI, there is a step dedicated to lint the two yaml files, as we
In the linting step, the [openDesk CI CLI](https://gitlab.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli) is used to apply the
aforementioned sorting, and the result is compared with the unsorted version. If there is a delta, the linting fails, and you can fix it by running the CLI tool locally, verifying and applying the result to your branch.
> **Note**<br>
> Please ensure that in component blocks, you use comments only at the beginning of the block or at its end. Ideally, you stick
with the many available examples in the yaml files.
> [!note]
> Please ensure that in component blocks, you use comments only at the beginning of the block or at its
> end. Ideally, you stick with the many available examples in the yaml files.
Example:
```yaml
@@ -126,7 +126,7 @@ Checks for newer versions of the given artifact and creates an MR containing the
- See also: https://gitlab.opencode.de/bmi/opendesk/tooling/oci-pull-mirror
> **Note:**<br>
> [!note]
> The mirror is scheduled to run every hour at 42 minutes past the hour.
openDesk strives to make all relevant artifacts available on openCode so there is a mirroring process

19
docs/developer/workflow.md
View File

@@ -85,7 +85,7 @@ The below rendering in [class diagram](https://en.wikipedia.org/wiki/Class_diagr
- the first section below the name of the class shows the required **characteristics** of each component of the given class
- the second section shows the **methods** like linting that must be applied to that class's artifacts
> **Note**<br>
> [!note]
> The methods prefixed with '-' are not yet available in `gitlab-config`. You will learn about them later.
```mermaid
@@ -148,11 +148,14 @@ openDesk uses Apache 2.0 as the license for their work. A typical reuse copyrigh
```
The way to mark the license header as a comment differs between the various file types. Please find matching examples for all types across the [deployment automation repository](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk).
> **Note**<br>
> If a `SPDX-FileCopyrightText` already exists with the copyright owner described above but with a past year (e.g. 2024), please update this copyright header line to cover (up to and including) the current year, e.g. `2024-2025`.
> [!note]
> If a `SPDX-FileCopyrightText` already exists with the copyright owner described above but with a past year
> (e.g. 2024), please update this copyright header line to cover (up to and including) the current year,
> e.g. `2024-2025`.
> **Note**<br>
> If line(s) with `SPDX-FileCopyrightText` containing a different copyright owner exist in the file you are working on, do not replace existing one(s), but rather add another header above these.
> [!note]
> If line(s) with `SPDX-FileCopyrightText` containing a different copyright owner exist in the file you are
> working on, do not replace existing one(s), but rather add another header above these.
## Development workflow
@@ -348,14 +351,14 @@ Branches created from the `develop` branch have to adhere to the following notat
Example: `tmueller/fix_jitsi_theming`.
> **Note**<br>
> [!note]
> The above naming convention has yet to be enforced, but please ensure you use it.
#### Commit messages / Conventional Commits
Commit messages must adhere to the [Conventional Commit standard](https://www.conventionalcommits.org/en/v1.0.0/#summary). Commits that do not adhere to the standard get rejected by either [Gitlab push rules](https://docs.gitlab.com/ee/user/project/repository/push_rules.html) or the CI.
> **Note**<br>
> [!note]
> The first letter after the `: ` must be uppercase.
```text
@@ -372,7 +375,7 @@ Commit messages must adhere to the [Conventional Commit standard](https://www.co
Example: `fix(open-xchange): Bump to 8.26 to heal issue with functional mailbox provisioning.`
> **Note**<br>
> [!note]
> The commit messages are an essential part of the [technical releases](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/releases) as the release notes are generated from these messages.
#### Verified commits