Merge pull request #267 from camunda-community-hub/np-format-md

Format markdown with spotless

.github/ISSUE_TEMPLATE/type_bug.md

@@ -1,4 +1,5 @@
 ---
+
 name: Bug report
 about: Create a report to help us improve
 title: ''
@@ -26,8 +27,7 @@ If possible add the full stacktrace or Zeebe log which contains the issue.
 </pre>
 </details>
 
-
 **Environment:**
- - OS: [e.g. Linux]
- - Docker version: [e.g. 19.03.5]
- - Zeebe Test Container version: [e.g. 0.22.1]
+- OS: [e.g. Linux]
+- Docker version: [e.g. 19.03.5]
+- Zeebe Test Container version: [e.g. 0.22.1]

.github/ISSUE_TEMPLATE/type_docs.md

@@ -1,4 +1,5 @@
 ---
+
 name: Documentation issue
 about: Improvements, additions, or modifications of the documentation
 title: ''

.github/ISSUE_TEMPLATE/type_feature.md

@@ -1,4 +1,5 @@
 ---
+
 name: Feature request
 about: Request user facing changes, e.g. API changes
 title: ''

.github/ISSUE_TEMPLATE/type_maintenance.md

@@ -1,4 +1,5 @@
 ---
+
 name: General issue
 about: General, non-user facing changes, e.g. refactoring, clean ups, etc.
 title: ''

.github/ISSUE_TEMPLATE/type_project.md

@@ -1,4 +1,5 @@
 ---
+
 name: Project management issue
 about: Changes or improvements to the project, e.g. bot configurations, code style, etc.
 title: ''

.github/ISSUE_TEMPLATE/type_test.md

@@ -1,4 +1,5 @@
 ---
+
 name: Test issue
 about: Improvements or changes to the existing tests
 title: ''

.github/pull_request_template.md

@@ -14,3 +14,4 @@ closes #
 - [ ] The submitting code follows our [code style](https://github.com/camunda-cloud/zeebe/wiki/Code-Style)
 - [ ] If submitting code, please run `mvn clean install -DskipTests` locally before committing
 - [ ] Ensure all PR checks are green
+

README.md

@@ -269,10 +269,10 @@ The container is considered started if and only if:
    about the
    ports [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/network-ports/))
    .
-1. The broker ready check returns a 204 (see more about this
+2. The broker ready check returns a 204 (see more about this
    check [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/health/#ready-check))
    .
-1. The gateway topology is considered complete.
+3. The gateway topology is considered complete.
 
 > A topology is considered complete if there is a leader for all partitions.
 
@@ -291,7 +291,7 @@ The container is considered started if and only if:
    the
    ports [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/network-ports/))
    .
-1. The broker ready check returns a 204 (see more about this
+2. The broker ready check returns a 204 (see more about this
    check [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/health/#ready-check))
    .
 
@@ -311,7 +311,7 @@ The container is considered started if and only if:
 1. The cluster and gateway ports are open and accepting connections (read more about the
    ports [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/network-ports/))
    .
-1. The gateway topology is considered complete.
+2. The gateway topology is considered complete.
 
 > A topology is considered complete if there is a leader for all partitions.
 
@@ -328,7 +328,7 @@ variables or via configuration file. You can find out more about it on the
 > Zeebe 0.23.x and upwards use Spring Boot for configuration - refer to their documentation on how
 > environment variables are mapped to configuration settings. You can read more about this
 > [here](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config)
-
+>
 > Testcontainers provide mechanisms through which
 > [environment variables can be injected](https://www.javadoc.io/doc/org.testcontainers/testcontainers/1.14.3/org/testcontainers/containers/GenericContainer.html#withEnv-java.lang.String-java.lang.String-),
 > or [configuration files mounted](https://www.testcontainers.org/features/files/). Refer to their
@@ -1004,26 +1004,28 @@ To work on an issue, follow the following steps:
 
 1. Check that a [GitHub issue][issues] exists for the task you want to work on. If one does not,
    create one.
-1. Checkout the `master` branch and pull the latest changes.
+2. Checkout the `master` branch and pull the latest changes.
+
    ```
    git checkout develop
    git pull
    ```
-1. Create a new branch with the naming scheme `issueId-description`.
+3. Create a new branch with the naming scheme `issueId-description`.
+
    ```
    git checkout -b 123-my-new-feature
    ```
-1. Follow
+4. Follow
    the [Google Java Format](https://github.com/google/google-java-format#intellij-android-studio-and-other-jetbrains-ides)
    and [Zeebe Code Style](https://github.com/zeebe-io/zeebe/wiki/Code-Style) while coding.
-1. Implement the required changes on your branch, and make sure to build and test your changes
+5. Implement the required changes on your branch, and make sure to build and test your changes
    locally before opening a pull requests for review.
-1. If you want to make use of the CI facilities before your feature is ready for review, feel free
+6. If you want to make use of the CI facilities before your feature is ready for review, feel free
    to open a draft PR.
-1. If you think you finished the issue please prepare the branch for reviewing. In general the
+7. If you think you finished the issue please prepare the branch for reviewing. In general the
    commits should be squashed into meaningful commits with a helpful message. This means cleanup/fix
    etc commits should be squashed into the related commit.
-1. Finally, be sure to check on the CI results and fix any reported errors.
+8. Finally, be sure to check on the CI results and fix any reported errors.
 
 ## Commit Message Guidelines
 

SECURITY.md

@@ -4,8 +4,8 @@
 
 These are the versions currently maintained and supported. If you detect any security vulnerabilities for any of these, please report them as described below.
 
-| Version | Supported          |
-| ------- | ------------------ |
+| Version |     Supported      |
+|---------|--------------------|
 | 3.x.x   | :white_check_mark: |
 | 2.x.x   | :x:                |
 | 1.x.x   | :x:                |

pom.xml

@@ -335,6 +335,13 @@
               <expandEmptyElements>false</expandEmptyElements>
             </sortPom>
           </pom>
+          <markdown>
+            <includes>
+              <include>**/*.md</include>
+            </includes>
+
+            <flexmark/>
+          </markdown>
         </configuration>
         <executions>
           <execution>