Fixed ci errors and added makefile

Author: Christian-Rades

Makefile

@@ -0,0 +1,20 @@
+#! /usr/bin/env make
+
+user := "$(shell id -u):$(shell id -g)"
+ignored = '/docs/resources/references/* /docs/adr/*'
+
+.PHONY : help lint fix
+.DEFAULT_GOAL : help
+
+# This will output the help for each task. thanks to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+help: ## Show this help
+	@printf "\033[33m%s:\033[0m\n" 'Available commands'
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "  \033[32m%-18s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+lint: ## Runs the linting tool
+	docker run --rm -u ${user} -v "$(shell pwd):/docs:ro" -e INPUT_IGNORE=${ignored} avtodev/markdown-lint:v1.5 \
+	    --config /docs/markdown-style-config.yml /docs
+
+fix: ## Runs the linting tool and fixes simple mistakes
+	docker run --rm -u ${user} -v "$(shell pwd):/docs" -e INPUT_FIX=true -e INPUT_IGNORE=${ignored} avtodev/markdown-lint:v1.5 \
+	    --config /docs/markdown-style-config.yml /docs

guides/hosting/performance/performance-tweaks.md

@@ -187,7 +187,7 @@ The Shopware cache has a global cache id to clear the cache faster and work in a
 
 ## .env.local.php
 
-[Symfony recommends](https://symfony.com/doc/current/configuration.html#configuring-environment-variables-in-production) that a `.env.local.php` file is used in Production instead of a `.env` file, to skip parsing of the  .env file on every request. 
+[Symfony recommends](https://symfony.com/doc/current/configuration.html#configuring-environment-variables-in-production) that a `.env.local.php` file is used in Production instead of a `.env` file, to skip parsing of the  .env file on every request.
 If you are using a containerized environment, all those variables can also be set directly in the environment variables, instead of dumping then to a file.
 
 Since shopware 6.4.15.0 you can dump the content of the .env file to a `.env.local.php` file by running `bin/console system:setup --dump-env` or `bin/console dotenv:dump --env {APP_ENV}`.

guides/installation/from-scratch.md

@@ -8,9 +8,9 @@ Be aware this will be a vastly more complex solution since additional system req
 
 ## Prerequisites
 
- - A Linux-based operating system (Windows installation is not covered here, but notes are provided about installing within a WSL instance)
- - An [Apache2 server installation](https://httpd.apache.org/docs/2.4/install.html) within the Linux-based operating system you have selected
- - Installation of all of the required packages mentioned in the [Installation overview](overview.md), there are two main goals you need to accomplish.
+- A Linux-based operating system (Windows installation is not covered here, but notes are provided about installing within a WSL instance)
+- An [Apache2 server installation](https://httpd.apache.org/docs/2.4/install.html) within the Linux-based operating system you have selected
+- Installation of all of the required packages mentioned in the [Installation overview](overview.md), there are two main goals you need to accomplish.
 
 Please note that this guide is rather based on plugin development and contribution. If you need a template for full composer-based shop projects, please refer to the [production template](https://github.com/shopware/production).
 
@@ -22,10 +22,10 @@ Firstly, we need to set up Apache to locate Shopware 6. If you wish you could co
 
 In order to do this, you should add a vhost definition to your Apache site configuration.
 
- 1) Create a file with the following pattern: `/etc/apache2/sites-available/*.conf`.
+1) Create a file with the following pattern: `/etc/apache2/sites-available/*.conf`.
 Here we will create a file called `/etc/apache2/sites-available/shopware-install.conf`
 
- 2) Within the created `shopware-install.conf` file place the following configuration:
+1) Within the created `shopware-install.conf` file place the following configuration:
 
 ```text
 <VirtualHost *:80>
@@ -46,12 +46,14 @@ Here we will create a file called `/etc/apache2/sites-available/shopware-install
 </VirtualHost>
 ```
 
-3) Symlink the `shopware-install.conf` file to the Apache2 `sites-enabled` directory:
+1) Symlink the `shopware-install.conf` file to the Apache2 `sites-enabled` directory:
+
 ```shell
 sudo ln -s /etc/apache2/sites-available/shopware-install.conf /etc/apache2/sites-enabled/shopware-install.conf
 ```
 
-4) Restart the Apache2 service in order to activate your new configuration:
+1) Restart the Apache2 service in order to activate your new configuration:
+
 ```shell
 # Your mileage with this command may vary depending upon your chosen Linux operating system
 sudo service apache2 restart
@@ -77,36 +79,35 @@ Once `localhostForwarding` is enabled, you should update you name your local dev
 ```text
 xxxxxx.dev.localhost
 ```
+
 ...where 'xxxxxx' should be replaced with a 'hyphen/underscore separated' string.
 
 {% hint style="info" %}
-Make sure the `APP_URL` variable defined within your `[PROJECT_ROOT]/.env` file matches the `ServerName` value within your Apache2 Vhost configuration 
+Make sure the `APP_URL` variable defined within your `[PROJECT_ROOT]/.env` file matches the `ServerName` value within your Apache2 Vhost configuration
 {% endhint %}
 
-
 ### Apache2 server configuration
 
 Make sure following Apache modules are enabled:
 
-* mod\_rewrite
-* mod\_headers
-* mod\_negotiation
+- mod\_rewrite
+- mod\_headers
+- mod\_negotiation
 
 {% hint style="info" %}
-Checking if these modules are installed on apache is possible with the command `apachectl -M | grep [module_name]`. When searching for a specific module with `grep` make sure to only use the name suffix, such as "rewrite" 
+Checking if these modules are installed on apache is possible with the command `apachectl -M | grep [module_name]`. When searching for a specific module with `grep` make sure to only use the name suffix, such as "rewrite"
 {% endhint %}
 
 After a quick restart of apache you are done here.
 
 {% hint style="info" %}
-For Mac (OSX) operating systems: 
+For Mac (OSX) operating systems:
 
-In your apache config, it is recommended to move the document root folder to the user's `$HOME` folder in order to avoid permission issues. This is the folder where Apache looks to serve file from. By default, the document root is configured as `/usr/local/var/www`. 
+In your apache config, it is recommended to move the document root folder to the user's `$HOME` folder in order to avoid permission issues. This is the folder where Apache looks to serve file from. By default, the document root is configured as `/usr/local/var/www`.
 
 As this is a development machine, let's assume we want to change the document root to point to a folder in our own home directory. Search for the term "DocumentRoot" in your `httpd.conf` apache configuration, and you should see the following line:
 {% endhint %}
 
-
 ```bash
 DocumentRoot "/usr/local/var/www"
 ```

guides/plugins/apps/custom-data/custom-entities.md

@@ -62,6 +62,7 @@ you need the appropriate [permissions](../../../../resources/references/app-refe
 ## Shorthand prefix
 
 Since v6.4.15.0 it is possible to also use the `ce_` shorthand prefix for your custom entities to prevent problems with length restrictions of names inside the DB.
+
 ```xml
 <?xml version="1.0" encoding="utf-8" ?>
 <entities xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/shopware/platform/trunk/src/Core/System/CustomEntity/Xml/entity-1.0.xsd">
@@ -85,4 +86,4 @@ POST /api/search/ce_blog
 
 {% hint style="warning" %}
 Note that you can't rename existing custom entities as that would lead to the deletion of all existing data.
-{% endhint %}
+{% endhint %}