Maint/353 maintenance add docs linting (#354)

* 🔧 Added markdownlint linting configuration * 🚨 Fixed lint
it-at-m · Jan 22, 2025 · dc3c6c1 · dc3c6c1
1 parent 6651dd3
commit dc3c6c1
Show file tree

Hide file tree

Showing 14 changed files with 750 additions and 58 deletions.
diff --git a/docs/.markdownlint.jsonc b/docs/.markdownlint.jsonc
@@ -0,0 +1,9 @@
+// Configuration file to exclude or reconfigure markdownlint rules, see https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration for more information
+// By default, all rules are active.
+{
+  "default": true,
+  "no-duplicate-heading": {
+    "siblings_only": true,
+  },
+  "line-length": false,
+}
diff --git a/docs/.markdownlintignore b/docs/.markdownlintignore
@@ -0,0 +1,2 @@
+.vitepress
+node_modules
diff --git a/docs/.prettierrc b/docs/.prettierrc
@@ -1 +1 @@
-"@muenchen/prettier-codeformat"
+"@muenchen/prettier-codeformat"
diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css
@@ -1,27 +1,27 @@
 :root {
-    --muc-logo-filter: invert(0); /* Sets the default LHM logo color to black */
+  --muc-logo-filter: invert(0); /* Sets the default LHM logo color to black */
 }
 
 /* Dark mode specific configurations */
 .dark {
-    --muc-logo-filter: invert(1); /* Sets the LHM logo color to white */
+  --muc-logo-filter: invert(1); /* Sets the LHM logo color to white */
 }
 
 /* Enables footer on all pages instead of only the home page */
 footer.VPFooter {
-    display: block !important;
-    z-index: 100 !important;
+  display: block !important;
+  z-index: 100 !important;
 }
 
 @media all and (max-width: 450px) {
-    /* Hides the logo text on mobile phones */
-    .VPNav div.logo a {
-        overflow: hidden;
-        width: 23px;
-    }
-    /* Fixes compression of logo on phone screens */
-    .VPNav div.logo a img {
-        object-fit: cover;
-        object-position: left;
-    }
+  /* Hides the logo text on mobile phones */
+  .VPNav div.logo a {
+    overflow: hidden;
+    width: 23px;
+  }
+  /* Fixes compression of logo on phone screens */
+  .VPNav div.logo a img {
+    object-fit: cover;
+    object-position: left;
+  }
 }
diff --git a/docs/gateway.md b/docs/gateway.md
@@ -35,7 +35,7 @@ Beside the default behaviour there are some special route prefixes which are han
 ## Configuration
 
 | Var                                                      | Description                                                     | Example                                                                 |
-|----------------------------------------------------------|-----------------------------------------------------------------|-------------------------------------------------------------------------|
+| -------------------------------------------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------- |
 | `SPRING_PROFILES_ACTIVE`                                 | See [profiles](#profiles)                                       | `local,hazelcast-local`                                                 |
 | `SPRING_CLOUD_GATEWAY_ROUTES_<index>_ID`                 | ID of a route definition.                                       | `backend`                                                               |
 | `SPRING_CLOUD_GATEWAY_ROUTES_<index>_URI`                | The URI to route to if this route matches.                      | `http://backend-service:8080/`                                          |
@@ -67,7 +67,7 @@ spring:
         registration:
           sso:
             provider: sso
-            client-id: 
+            client-id:
             client-secret:
             # needed for userInfo endpoint
             scope: profile, openid
@@ -76,7 +76,7 @@ spring:
 ### Profiles
 
 | Profile           | Description                                                                                          |
-|-------------------|------------------------------------------------------------------------------------------------------|
+| ----------------- | ---------------------------------------------------------------------------------------------------- |
 | `json-logging`    | Switches logging from textual to JSON output.                                                        |
 | `no-security`     | Disables all security mechanisms (e.g. authentication, authorization, CSRF) Routing works as normal. |
 | `hazelcast-local` | Configures Spring Session Hazelcast for connection via localhost (i.e. local development).           |
@@ -86,23 +86,25 @@ spring:
 
 Beside the already mentioned properties Hazelcast also has the following requirements.
 
-#### Modular java
-See https://docs.hazelcast.com/hazelcast/5.5/getting-started/install-hazelcast#using-modular-java
+#### Modular Java
+
+See <https://docs.hazelcast.com/hazelcast/5.5/getting-started/install-hazelcast#using-modular-java>
 
 Following Java options need to be set.
 For the gateway image this can be done with `JAVA_OPTS_APPEND`.
-```
+
+```text
 --add-modules java.se \
-  --add-exports java.base/jdk.internal.ref=ALL-UNNAMED \
-  --add-opens java.base/java.lang=ALL-UNNAMED \
-  --add-opens java.base/java.nio=ALL-UNNAMED \
-  --add-opens java.base/sun.nio.ch=ALL-UNNAMED \
-  --add-opens java.management/sun.management=ALL-UNNAMED \
-  --add-opens jdk.management/com.ibm.lang.management.internal=ALL-UNNAMED \
-  --add-opens jdk.management/com.sun.management.internal=ALL-UNNAMED
+--add-exports java.base/jdk.internal.ref=ALL-UNNAMED \
+--add-opens java.base/java.lang=ALL-UNNAMED \
+--add-opens java.base/java.nio=ALL-UNNAMED \
+--add-opens java.base/sun.nio.ch=ALL-UNNAMED \
+--add-opens java.management/sun.management=ALL-UNNAMED \
+--add-opens jdk.management/com.ibm.lang.management.internal=ALL-UNNAMED \
+--add-opens jdk.management/com.sun.management.internal=ALL-UNNAMED
 ```
 
 #### Kubernetes
 
 For running Hazelcast with profile `hazelcast-k8s` in Kubernetes port `5701` needs to be accessible.
-This need to be configured for the Service and Deployment.
+This need to be configured for the Service and Deployment.
diff --git a/docs/integrations/address.md b/docs/integrations/address.md
@@ -24,5 +24,5 @@ The modules follow the [default naming convention](./index.md#naming-conventions
 ### refarch-address-integration-starter
 
 | Property              | Description                |
-|-----------------------|----------------------------|
+| --------------------- | -------------------------- |
 | `refarch.address.url` | URL of the address service |
diff --git a/docs/integrations/cosys.md b/docs/integrations/cosys.md
@@ -40,13 +40,13 @@ Whether a property is an alias can be checked in the corresponding `application.
 
 ### refarch-cosys-integration-starter
 
-| Property                             | Description                                                                   | Example          |
-|--------------------------------------|-------------------------------------------------------------------------------|------------------|
-| `refarch.cosys.url`                  | Url of the CoSys service                                                      |                  |
-| `refarch.cosys.merge.datafile`       |                                                                               | `/root/multi`    |
-| `refarch.cosys.merge.inputLanguage`  | incoming language                                                             | `Deutsch`        |
-| `refarch.cosys.merge.outputLanguage` | outgoing language                                                             | `Deutsch`        |
-| `refarch.cosys.merge.keepFields`     |                                                                               | `unresolved-ref` |
+| Property                             | Description              | Example          |
+| ------------------------------------ | ------------------------ | ---------------- |
+| `refarch.cosys.url`                  | Url of the CoSys service |                  |
+| `refarch.cosys.merge.datafile`       |                          | `/root/multi`    |
+| `refarch.cosys.merge.inputLanguage`  | incoming language        | `Deutsch`        |
+| `refarch.cosys.merge.outputLanguage` | outgoing language        | `Deutsch`        |
+| `refarch.cosys.merge.keepFields`     |                          | `unresolved-ref` |
 
 For authentication against cosys a OAuth2 registration with the name `cosys` needs to be provided.
 See following example or the [according Spring documentation](https://docs.spring.io/spring-security/reference/servlet/oauth2/index.html#oauth2-client).

diff --git a/docs/integrations/dms.md b/docs/integrations/dms.md
@@ -45,7 +45,7 @@ See [according documentation](./s3.md#usage).
 ### refarch-dms-integration-starter
 
 | Property                                  | Description                                                                                                    |
-|-------------------------------------------|----------------------------------------------------------------------------------------------------------------|
+| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
 | `refarch.dms.fabasoft.url`                | Url to fabasoft endpoint                                                                                       |
 | `refarch.dms.fabasoft.username`           | Technical fabasoft dms user                                                                                    |
 | `refarch.dms.fabasoft.password`           | Technical fabasoft dms password                                                                                |

diff --git a/docs/integrations/email.md b/docs/integrations/email.md
@@ -47,7 +47,7 @@ See [according documentation](./s3.md#usage).
 ### refarch-email-integration-starter
 
 | Property                                | Description                                       | Example                |
-|-----------------------------------------|---------------------------------------------------|------------------------|
+| --------------------------------------- | ------------------------------------------------- | ---------------------- |
 | `spring.mail.host`                      | Host of smtp server used for sending mails.       | `mail.example.com`     |
 | `spring.mail.port`                      | Host of smtp server used for sending mails.       | `1025`                 |
 | `spring.mail.username`                  | Username of smtp server.                          |                        |

diff --git a/docs/integrations/index.md b/docs/integrations/index.md
@@ -1,6 +1,6 @@
 # Integrations
 
-Integrations are ready to use implementations for accessing often used services in own applications without re-implementing the same logic. 
+Integrations are ready to use implementations for accessing often used services in own applications without re-implementing the same logic.
 These enable reduced coding effort and maintenance as well as standardized programming interfaces.
 
 ## Integrations

diff --git a/docs/integrations/s3.md b/docs/integrations/s3.md
@@ -20,7 +20,7 @@ The following graph shows the relationships between the various modules and how
 flowchart RL
     rest-service --> rest-starter --> rest-core --> core
     rest-starter --> starter --> core
-    
+
     java-client-starter --> java-client --> client-core
     java-client --> core
     java-client-starter --> starter
@@ -58,12 +58,12 @@ Whether a property is an alias can be checked in the corresponding `application.
 ### s3-integration-rest-service
 
 | Property                                        | Description                       | Example          |
-|-------------------------------------------------|-----------------------------------|------------------|
+| ----------------------------------------------- | --------------------------------- | ---------------- |
 | `refarch.s3.url`                                | URL of S3 endpoint to connect to. | `s3.example.com` |
 | `refarch.s3.bucket-name`                        | Name of the bucket to connect to. | `refarch-bucket` |
 | `refarch.s3.access-key`                         | Access key to use for connection. |                  |
 | `refarch.s3.secret-key`                         | Secret key to use for connection. |                  |
-| `refarch.s3.initial-connection-test` (optional) | Test connection to S3 at startup.  | `true` (default) |
+| `refarch.s3.initial-connection-test` (optional) | Test connection to S3 at startup. | `true` (default) |
 
 For authenticating the different endpoints OAuth 2.0 authentication needs to be configured.
 See below example or the [according Spring documentation](https://docs.spring.io/spring-security/reference/servlet/oauth2/index.html#oauth2-resource-server).
@@ -84,7 +84,7 @@ security:
 ### s3-integration-java-client-starter
 
 | Property                                                   | Description                                           | Example                  |
-|------------------------------------------------------------|-------------------------------------------------------|--------------------------|
+| ---------------------------------------------------------- | ----------------------------------------------------- | ------------------------ |
 | `refarch.s3.client.max-file-size` (optional)               | Single file limit for up- or downloading in byte.     | `10MB`                   |
 | `refarch.s3.client.max-batch-size` (optional)              | Limit for up- or downloading a list of files in byte. | `100MB`                  |
 | `refarch.s3.client.supported-file-extensions.*` (optional) | Map of allowed file extensions for up- and download.  | `pdf: "application/pdf"` |
@@ -93,10 +93,10 @@ security:
 
 All properties of [s3-integration-java-client-starter](#s3-integration-java-client-starter) and following:
 
-| Property                                 | Description                                                                | Example                                       |
-|------------------------------------------|----------------------------------------------------------------------------|-----------------------------------------------|
-| `refarch.s3.client.document-storage-url` | URL to the RefArch S3 integration service.                                 | `http://s3-integration-service:8080`          |
-| `refarch.s3.client.enable-security`      | Switch to enable or disable OAuth 2.0 authentication against S3 service.      | `true`                                        |
+| Property                                 | Description                                                              | Example                              |
+| ---------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------ |
+| `refarch.s3.client.document-storage-url` | URL to the RefArch S3 integration service.                               | `http://s3-integration-service:8080` |
+| `refarch.s3.client.enable-security`      | Switch to enable or disable OAuth 2.0 authentication against S3 service. | `true`                               |
 
 For authentication against the `s3-service` a OAuth 2.0 registration with the name `s3` needs to be provided.
 See following example or the [according Spring documentation](https://docs.spring.io/spring-security/reference/servlet/oauth2/index.html#oauth2-client).

diff --git a/docs/overview.md b/docs/overview.md
@@ -60,7 +60,7 @@ The template is described [here](https://refarch-templates.oss.muenchen.de/webco
 
 ## Enterprise Application Integration (EAI)
 
-Beside the development of web applications, the RefArch also provides a template for enterprise application integration (EAI). 
+Beside the development of web applications, the RefArch also provides a template for enterprise application integration (EAI).
 This enables integration between existing applications. By default, most applications won't require this template.
 
 The template is described [here](https://refarch-templates.oss.muenchen.de/eai).
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		"@muenchen/prettier-codeformat"
		"@muenchen/prettier-codeformat"