add to ci, fix linter problems (#378)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: AlexAndBear

.markdownlint-cli2.jsonc

@@ -4,6 +4,7 @@
   "ignores": [
     ".git",
     "node_modules",
+    "build",
     "static",
     "assets",
     "CHANGELOG.md",

.markdownlint.json

@@ -1,7 +1,8 @@
 {
   "default": true,
-  "MD003": false, // Disable MD003 to allow different heading styles
   "MD013": false, // Disable MD013 to allow long lines
   "MD033": false, // Disable MD033 to allow inline HTML
-  "MD029": { "style": "ordered" } // Ensure ordered lists are used
+  "MD024": false, // Disable MD024 to allow headings with the same text
+  "MD025": false, // Disable MD025 to allow frontmatter title with different content as heading ( e.g. Nav items should should be short)
+  "MD029": false // TODO: Too much false positives
 }

.woodpecker/build.yaml

@@ -9,6 +9,11 @@ steps:
     image: quay.io/thegeeklab/git-batch
     commands:
       - git batch -vv
+  - name: lint-md
+    image: owncloudci/nodejs:20
+    commands:
+      - pnpm install
+      - pnpm lint:md
   - name: format-check
     image: owncloudci/nodejs:20
     commands:

README.md

@@ -4,15 +4,15 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
 
 ### Installation
 
-```Shell
+```bash
 pnpm install
 ```
 
 ### Local Development
 
 clone this repository
 
-```Shell
+```bash
 pnpm start
 ```
 
@@ -22,15 +22,15 @@ This command starts a local development server and opens up a browser window. Mo
 
 To see the docs in German you need to start it with the following command
 
-```Shell
+```bash
 pnpm run start --locale de
 ```
 
 It is not possible to switch between the languages via the language switcher
 
 ### Build
 
-```Shell
+```bash
 pnpm build
 ```
 
@@ -40,13 +40,13 @@ This command generates static content into the `build` directory and can be serv
 
 Using SSH:
 
-```Shell
+```bash
 USE_SSH=true pnpm deploy
 ```
 
 Not using SSH:
 
-```Shell
+```bash
 GIT_USER=<Your GitHub username> pnpm deploy
 ```
 

docs/admin/configuration/authentication-and-user-management/keycloak.md

@@ -21,7 +21,7 @@ You can also use one of our predefined Docker Compose setups, which are located
 
 ### Server Configuration
 
-```
+```env
 PROXY_AUTOPROVISION_ACCOUNTS=true|false # that depends on your setup
 PROXY_ROLE_ASSIGNMENT_DRIVER=oidc
 OC_OIDC_ISSUER=https://your-domain.example.com/realms/openCloud
@@ -36,7 +36,7 @@ GRAPH_USERNAME_MATCH=none
 OC_EXCLUDE_RUN_SERVICES=idp,idm # it is not supported to run keycloak with the built-in idm
 ```
 
-Look [here](./external-idp.md#opencloud-configuration) for some more details about these settings.
+Look [OpenCloud external IDP configuration](./external-idp.md#opencloud-configuration) for some more details about these settings.
 
 ### Client Configuration
 

docs/admin/configuration/radicale-integration.md

@@ -31,13 +31,13 @@ deployment based on the `opencloud_full` deployment example.
 In the root directory of the `opencloud_full` deployment example, usually `opencloud/deployments/examples/opencloud_full`,
 remove the `#` symbol from the line:
 
-```
+```env
 #RADICALE=:radicale.yml
 ```
 
 ### 2. Update the deployment
 
-```
+```bash
 docker compose up -d
 ```
 

docs/admin/configuration/storage/decomposeds3.md

@@ -22,29 +22,29 @@ Decomposeds3 is a storage driver for OpenCloud that uses MinIO, an S3-compatible
 
 Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration):
 
-```Shell
+```bash
 git clone https://github.com/opencloud-eu/opencloud.git
 ```
 
 ## 2. Start
 
 Navigate to the Docker Compose configuration folder:
 
-```Shell
+```bash
 cd opencloud/deployments/examples/opencloud_full
 ```
 
 Enable `decomposeds3.yml` and `minio.yml` in the `.env` file:
 
-```Shell
+```bash
 nano opencloud/deployments/examples/opencloud_full/.env
 ```
 
 Find all required environment variables `env` here: [decomposeds3-envs](https://github.com/opencloud-eu/opencloud/blob/main/services/storage-users/pkg/config/config.go#L143-L176)
 
 Start the deployment with Docker Compose:
 
-```Shell
+```bash
 docker compose up -d
 ```
 
@@ -54,7 +54,7 @@ This starts all necessary containers in the background.
 
 Edit the /etc/hosts file and add the following entries for local access:
 
-```
+```bash
 127.0.0.1       cloud.opencloud.test
 127.0.0.1       minio.opencloud.test
 ```

docs/admin/configuration/storage/posixfs.md

@@ -111,6 +111,6 @@ It is essential to maintain correct file ownership and permissions when modifyin
 
 In addition to the configuration required for non-collaborative mode, the following setting must be enabled for local file systems such as XFS, ext4, and others:
 
-```
+```env
 STORAGE_USERS_POSIX_WATCH_FS=true
 ```

docs/admin/getting-started/container/docker-compose-local.md

@@ -21,7 +21,7 @@ Spin up a temporary local instance of OpenCloud using **Docker Compose**.
 
 Clone the OpenCloud repository:
 
-```Shell
+```bash
 git clone https://github.com/opencloud-eu/opencloud-compose.git
 ```
 
@@ -31,13 +31,13 @@ git clone https://github.com/opencloud-eu/opencloud-compose.git
 
 ### cd into the Docker Compose configuration folder
 
-```Shell
+```bash
 cd opencloud-compose
 ```
 
 ### Create environment file
 
-```Shell
+```bash
 cp .env.example .env
 ```
 
@@ -47,27 +47,27 @@ cp .env.example .env
 
 You can deploy using explicit -f flags:
 
-```Shell
+```bash
 docker compose -f docker-compose.yml -f weboffice/collabora.yml -f traefik/opencloud.yml -f traefik/collabora.yml up -d
 ```
 
 Or by uncomment or adding the COMPOSE_FILE variable in .env:
 
-```Shell
+```bash
 COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
 ```
 
 Set you initial admin password in the .env
 
-```Shell
+```bash
 INITIAL_ADMIN_PASSWORD=YOUR.SECRET.PASSWORD
 ```
 
 This is mandatory for security reasons. Otherwise the OpenCloud container will not start.
 
 Start the deployment with Docker Compose:
 
-```Shell
+```bash
 docker compose up -d
 ```
 
@@ -81,7 +81,7 @@ This starts all necessary containers in the background.
 
 Edit the /etc/hosts file and add the following entries for local access:
 
-```
+```bash
 127.0.0.1       cloud.opencloud.test
 127.0.0.1       collabora.opencloud.test
 127.0.0.1       wopiserver.opencloud.test

docs/admin/getting-started/container/docker-compose/docker-compose.md

@@ -257,7 +257,7 @@ If you encounter any issues, check the [Common Issues & Help](./../../../resourc
 
 <br/>
 
-#### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file
+### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file
 
 ```env
 LDAP=:ldap.yml
@@ -271,7 +271,7 @@ KEYCLOAK_ADMIN_PASSWORD="your.save.password"
 
 This will include the LDAP and Keycloak service definitions in the Docker Compose setup.
 
-#### After starting OpenCloud, Keycloak will be available at
+### After starting OpenCloud, Keycloak will be available at
 
 ```bash
 https://keycloak.your.domain
@@ -281,7 +281,7 @@ https://keycloak.your.domain
 
 ### Once Keycloak is running
 
-**1. Open your browser and go to**
+#### 1. Open your browser and go to
 
 ```bash
 https://keycloak.your.domain
@@ -290,15 +290,18 @@ https://keycloak.your.domain
 <img src={require("./../../img/docker-compose/keycloak-dashboard.png").default} alt="Keyclosk dashboard" width="1920"/>
 <br/><br/>
 
-**2. Log in with the admin credentials (default is admin / admin).**
+#### 2. Log in with the admin credentials (default is admin / admin)
+
 <img src={require("./../../img/docker-compose/keycloak-login.png").default} alt="Keycloak login" width="1920"/>
 <br/><br/>
 
-**3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm.**
+#### 3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm
+
 <img src={require("./../../img/docker-compose/top-left-dropdown.png").default} alt="Top left dropdown menue" width="400"/>
 <br/><br/>
 
-**4. Navigate to the "Users" section and click "Add user":**
+#### 4. Navigate to the "Users" section and click "Add user"
+
 <img src={require("./../../img/docker-compose/users-section.png").default} alt="User section" width="1920"/>
 <br/>
 
@@ -308,7 +311,7 @@ https://keycloak.your.domain
   <img src={require("./../../img/docker-compose/fill-in-userdata.png").default} alt="Fill in userdata" width="1920"/>
   <br/><br/>
 
-**5. Go to the "Credentials" tab:**
+#### 5. Go to the "Credentials" tab
 
 - Click "Set password"
   <img src={require("./../../img/docker-compose/credentials.png").default} alt="Credentials" width="1920"/>
@@ -319,7 +322,8 @@ https://keycloak.your.domain
   <img src={require("./../../img/docker-compose/set-password.png").default} alt="Set password" width="400"/>
   <br/><br/>
 
-**6. Go to the "Role Mapping" tab:**
+#### 6. Go to the "Role Mapping" tab
+
 <img src={require("./../../img/docker-compose/role-mapping.png").default} alt="Role mapping" width="1920"/>
 <br/>
 
@@ -334,4 +338,4 @@ https://keycloak.your.domain
   <img src={require("./../../img/docker-compose/realm-roles.png").default} alt="Realm roles" width="1920"/>
   <br/>
 
-**The user can now log in via OpenCloud using the Keycloak credentials.**
+The user can now log in via OpenCloud using the Keycloak credentials.