Add markdown-lint

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: Lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v4
+        with:
+          show-progress: ''
+      - name: markdownlint-cli2-action
+        uses: DavidAnson/markdownlint-cli2-action@v9
+        with:
+          globs: |
+            **/*.md
+            #node_modules

.markdownlint.yml

@@ -0,0 +1,3 @@
+default: true
+
+MD013: false

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "DavidAnson.vscode-markdownlint",
+        "editorconfig.editorconfig"
+    ]
+}

docs/azure/azure_code_redeem_instructions.md

@@ -1,8 +1,8 @@
-# SDV Hackathon Azure Pass Code Instructions 
+# SDV Hackathon Azure Pass Code Instructions
 
 ## Azure Pass Codes
 
-Each Hackathon Team will have at their disposal an Azure Pass Code to redeem and can use Azure to build their applications and solutions. 
+Each Hackathon Team will have at their disposal an Azure Pass Code to redeem and can use Azure to build their applications and solutions.
 
 You can find the Azure Promo Codes here [PromoCode](./SDV_hackathon_codes.xlsx). We have 20 promo codes available, 1 per each hackathon team with a cap spend of $150.
 
@@ -11,4 +11,3 @@ Please ensure that only 1 Promo Code is used per Hackathon Team. As soon as you
 ## Azure Pass Code Redeem Instructions
 
 Each Hack Team will need to activate it before use. Instructions on how to redeem can be found here [Redeeming a Microsoft Azure Pass Promo Code](https://www.microsoftazurepass.com/Home/HowTo?Length=5).
-

docs/azure/azure_container_registry_instructions.md

@@ -1,28 +1,31 @@
-# Azure Container Registry 
+# Azure Container Registry
 
 Azure Container Registry is a managed registry service based on the open-source Docker Registry 2.0 allowing you to create and maintain your container images in Azure.
 
 We have pre-built amd64 and arm64 container images for the in-vehicle software stack comprised by Eclipse Ibeji, Eclipse Agemo, Eclipse Freyja, and Eclipse Chariott so that you can focus on building your own scenarios.
 
 ## Maestro Challenge Azure Container Registry
 
-You can access the pre-built container images here: 
+You can access the pre-built container images here:
+
 * sdvblueprint.azurecr.io
 
 You will be prompted for username and password to pull the pre-built container images.
+
 * username: 5a3386a7-640d-4ec7-af9d-4009fd381a3b
 
-> **Note** 
+> **Note**
 please contact the Maestro Hack Coaches for the password.
 
-## How to use 
+## How to use
 
 You can pull the images using [Docker](https://docs.docker.com/engine/reference/commandline/pull/) or [Podman](https://docs.podman.io/en/latest/markdown/podman-pull.1.html) as shown below:
 
 When you run the below command, you will be prompted for username and password. Please use the username provided above and contact the Maestro Challenge hack coaches for the password.
 
 > **Podman**
-```
+
+```shell
 podman pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-agemo/pub-sub-service:0.1.0
 podman pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-chariott/service-discovery:0.1.1
 podman pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-ibeji/invehicle-digital-twin:0.1.0
@@ -33,7 +36,8 @@ podman pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-freyja/azure-cloud-conn
 ```
 
 > **Docker**
-```
+
+```shell
 docker pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-agemo/pub-sub-service:0.1.0
 docker pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-chariott/service-discovery:0.1.1
 docker pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-ibeji/invehicle-digital-twin:0.1.0
@@ -43,9 +47,9 @@ docker pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-freyja/cloud-with-ibeji
 docker pull sdvblueprint.azurecr.io/sdvblueprint/eclipse-freyja/azure-cloud-connector:0.1.0
 ```
 
-> **Note** 
+> **Note**
 Ensure you use the full domain name of the container registry.
 
-## Aditional Information
+## Additional Information
 
-If you would like to know more about Azure Container Registry, extensive documentation and examples are available [Introduction to Container registries in Azure](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-intro) 
+If you would like to know more about Azure Container Registry, extensive documentation and examples are available [Introduction to Container registries in Azure](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-intro)

docs/in-vehicle-stack/azure-cloud-connection.md

@@ -1,9 +1,9 @@
-## In-Vehicle Stack with Cloud Connectivity
+# In-Vehicle Stack with Cloud Connectivity
 
 The default in-vehicle stack is all local with no cloud connection. Follow the below steps to
 enable cloud connection with Azure Digital Twins using Eclipse Freyja.
 
-### Create Azure Digital Twins Instance
+## Create Azure Digital Twins Instance
 
 1. Please refer to the following documentation to setup the Azure Digital Twins instance: [Automated Azure Digital Twins Setup for Smart Trailer Example](https://github.com/eclipse-ibeji/ibeji-example-applications/blob/main/cloud_connectors/azure/digital_twins_connector/README.md#automated-azure-digital-twins-setup-for-smart-trailer-example).
 This will create the Azure Digital Twins with the appropriate DTDL for the smart trailer use case.
@@ -12,13 +12,13 @@ This will create the Azure Digital Twins with the appropriate DTDL for the smart
 [Open instance in Azure Digital Twins Explorer](https://learn.microsoft.com/en-us/azure/digital-twins/quickstart-azure-digital-twins-explorer#open-instance-in-azure-digital-twins-explorer)
 to get the url for your instance. Copy this url for later.
 
-### Change In-Vehicle Stack to use Cloud-Connected Components
+## Change In-Vehicle Stack to use Cloud-Connected Components
 
 The following changes will vary depending on which Orchestrator you are using. Broadly, we need to
 change the Freyja container image from the in-memory version to the cloud version and add a
 workload for the Azure cloud connector used by Freyja.
 
-#### Eclipse Ankaios
+### Eclipse Ankaios
 
 1. Change the `digital_twin_cloud_sync` workload in
 [startupState.yaml](../../eclipse-ankaios/config/startupState.yaml) to point to the `cloud-with-ibeji`
@@ -80,7 +80,7 @@ Connector to establish connection. Run:
     To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code <DEVICE_CODE> to authenticate.
     ```
 
-2. Validate you have successfully logged in by re-running
+1. Validate you have successfully logged in by re-running
 
     ```shell
     podman logs cloud-connector
@@ -95,17 +95,20 @@ Connector to establish connection. Run:
 
     If you see the device code login text, wait 10 seconds and try the podman command again.
 
-7. The In-Vehicle Stack is now initialized and connected to the cloud!
+1. The In-Vehicle Stack is now initialized and connected to the cloud!
 
-#### Eclipse BlueChi
+### Eclipse BlueChi
 
 1. In the BlueChi devcontainer, modify the `/usr/local/bin/bluechi-env-bootstrap` to remove `freyja` (this image includes the in-memory mock version of Freyja) and use `cloud-with-ibeji` and `azure-cloud-connector` services instead:
     - Add the following two lines:
+
         ```shell
         systemctl start cloud-with-ibeji
         systemctl start azure-cloud-connector
         ```
+
     - Your complete file should now look like:
+
       ```shell
       #!/bin/bash
 
@@ -164,7 +167,7 @@ Connector to establish connection. Run:
     To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code <DEVICE_CODE> to authenticate.
     ```
 
-2. Validate you have successfully logged in by re-running
+1. Validate you have successfully logged in by re-running
 
     ```shell
     systemctl status azure-cloud-connector
@@ -179,4 +182,4 @@ Connector to establish connection. Run:
 
     If you see the device code login text, wait 10 seconds and try the podman command again.
 
-7. The In-Vehicle Stack is now initialized and connected to the cloud!
+1. The In-Vehicle Stack is now initialized and connected to the cloud!

docs/in-vehicle-stack/config-overrides.md

@@ -1,25 +1,25 @@
-## How to Override Configuration for In-Vehicle Stack Containers
+# How to Override Configuration for In-Vehicle Stack Containers
 
 The following In-Vehicle Stack services have configuration that can be overridden:
 
 - Eclipse Agemo:
-    - [Configuration](https://github.com/eclipse-chariott/Agemo/blob/main/docs/config-overrides.md)
+  - [Configuration](https://github.com/eclipse-chariott/Agemo/blob/main/docs/config-overrides.md)
 - Eclipse Freyja:
-    - [Mapping Configuration](https://github.com/eclipse-ibeji/freyja/blob/main/mapping_clients/in_memory_mock_mapping_client/README.md)
-    - [Cloud Connector Configuration](https://github.com/eclipse-ibeji/ibeji-example-applications/blob/main/cloud_connectors/azure/digital_twins_connector/src/core/adt_instance_config.sample.json)
+  - [Mapping Configuration](https://github.com/eclipse-ibeji/freyja/blob/main/mapping_clients/in_memory_mock_mapping_client/README.md)
+  - [Cloud Connector Configuration](https://github.com/eclipse-ibeji/ibeji-example-applications/blob/main/cloud_connectors/azure/digital_twins_connector/src/core/adt_instance_config.sample.json)
 - Eclipse Ibeji:
-    - [In-Vehicle Digtial Twin Configuration](https://github.com/eclipse-ibeji/ibeji/blob/main/core/invehicle-digital-twin/template/invehicle_digital_twin_settings.yaml)
-    - [Managed Subscribe Configuration](https://github.com/eclipse-ibeji/ibeji/blob/main/core/module/managed_subscribe/template/managed_subscribe_settings.yaml)
+  - [In-Vehicle Digtial Twin Configuration](https://github.com/eclipse-ibeji/ibeji/blob/main/core/invehicle-digital-twin/template/invehicle_digital_twin_settings.yaml)
+  - [Managed Subscribe Configuration](https://github.com/eclipse-ibeji/ibeji/blob/main/core/module/managed_subscribe/template/managed_subscribe_settings.yaml)
 
 Please refer to the above links to determine what configuration files you would like to override. Then follow the steps below for the specific orchestrator you are using.
 
-### Override In-Vehicle Stack configuration in Eclipse Ankaios
+## Override In-Vehicle Stack configuration in Eclipse Ankaios
 
-#### Prerequisites
+### Prerequisites
 
 - Follow steps to setup the [Ankaios Development Environment](../../eclipse-ankaios/README.md#ankaios-maestro-challenge-development-environment)
 
-#### Steps
+### Steps
 
 1. In the Ankaios devcontainer, open a terminal and create a directory under `/etc` to store the
 desired project configuration files:
@@ -47,7 +47,7 @@ desired project configuration files:
     ```
 
 1. Populate the newly created configuration files with the configuration you wish to override using
-any text editor. 
+any text editor.
 
 1. Next, we need to pass the configuration into the containers. To do this, we will need to modify
 [startupState.yaml](../../eclipse-ankaios/config/startupState.yaml). This will be done by mounting the
@@ -72,13 +72,13 @@ The In-Vehicle Stack service will now use your modified configuration. Note that
 changes will require a restart of the in-vehicle stack. You can restart the in-vehicle stack by following the steps for
 [Ankaios](../../eclipse-ankaios/README.md#startup-check-before-development).
 
-### Override In-Vehicle Stack configuration in Eclipse BlueChi
+## Override In-Vehicle Stack configuration in Eclipse BlueChi
 
-#### Prerequisites
+### Prerequisites
 
 - Follow steps to setup [Eclipse BlueChi](../../eclipse-bluechi/README.md)
 
-#### Steps
+### Steps
 
 1. In the BlueChi devcontainer, open a terminal and create a directory under `/etc` to store the
 desired project configuration files:
@@ -106,7 +106,7 @@ desired project configuration files:
     ```
 
 1. Populate the newly created configuration files with the configuration you wish to override using
-any text editor. 
+any text editor.
 
 1. Next, we need to pass the configuration into the containers. To do this, we will need to modify
 the `/etc/containers/systemd/<service_name>.yml` file for your service (replace <service_name> with your service name). This will be done by mounting the
@@ -134,6 +134,7 @@ directory created in step 1 into the container using `volumeMounts`. You can see
         ```
 
     - Refer to this volume in the "containers" section, for example:
+
       ```yaml
         containers:
           - name: app
@@ -147,3 +148,5 @@ directory created in step 1 into the container using `volumeMounts`. You can see
 The In-Vehicle Stack service will now use your modified configuration. Note that any configuration
 changes will require a restart of the in-vehicle stack. You can restart the in-vehicle stack by following the steps for
 [BlueChi](../../eclipse-bluechi/README.md#bootstrapping) cleanup and bootstrap again.
+
+<!-- markdownlint-disable-file MD024 -->