Updating and adding pages.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

docs/DEPENDABOT.md

@@ -4,17 +4,17 @@ SPDX-FileCopyrightText: 2021 Alliander N.V.
 SPDX-License-Identifier: CC-BY-4.0
 -->
 
-## Dependabot
+# Dependabot
 
-### Configure Dependabot Settings
+## Configure Dependabot Settings
 
 The first step is that we want to enable Alerts from Dependabot. This needs to be done for every repository that 
 uses Dependabot. Go to the settings of the repository and select "Security & analysis". Next enable "Dependabot alerts"
 and "Dependabot security updates".
 
 Also remember to give the repository access to the secret DB_GITHUB_PACKAGES at organization level.
 
-### Configure Dependabot (yaml)
+## Configure Dependabot (yaml)
 
 Next step is to add a configuration file to the repository that will enable Dependabot. In the repository create a 
 file "dependabot.yml" in the directory ".github". The basic content will be something like
@@ -80,7 +80,7 @@ the JAXB Implementation can't higher.
 Dependabot uses the configuration found in the default branch (often 'develop'), so to make it effective use a 
 pull request to merge it into the default branch.
 
-### Adding Dependabot Secret DB_GITHUB_PACKAGES
+## Adding Dependabot Secret DB_GITHUB_PACKAGES
 
 Tot access GitHub Packages a secret DB_GITHUB_PACKAGES needs to be created.
 - First create a new personal access token from https://github.com/settings/tokens. Tokens can only be created as personal tokens.
@@ -91,7 +91,7 @@ Tot access GitHub Packages a secret DB_GITHUB_PACKAGES needs to be created.
 
 Now Dependabot can use this secret to access GitHub Packages.
 
-### Handling the pull request
+## Handling the pull request
 
 Pull request created by Dependabot can be handled just like other pull request, but there is 1 issue to know.  
 Some GitHub Actions, like SonarCloud and AutomateProjects, will fail if they are started by the pull request from

docs/DEPLOYMENT.md

@@ -4,10 +4,10 @@ SPDX-FileCopyrightText: 2021 Alliander N.V.
 SPDX-License-Identifier: CC-BY-4.0
 -->
 
-## Deployment of CoMPAS
+# Deployment of CoMPAS
 We deploy the (native) Docker image of all CoMPAS services to Docker Hub. This way, it can be pulled and deployed into environments of your choice (OpenShift for example).
 
-### Quick Deployment instructions (under construction)
+## Quick Deployment instructions (under construction)
 The following instructions are terminal instructions for publishing a Quarkus docker image to Docker Hub. This should be done by a Github Action in the future.
 
 ```
@@ -26,6 +26,6 @@ Few points in this single command:
 - `-Dquarkus.container-image.name=name` defining the name of the image. Standard it's 'app'.
 - `-Dquarkus.container-image.push=true` deploys to docker image to Docker Hub.
 
-## Sources
-#### Full documentation about deploying Quarkus application to Docker Hub
-https://dev.to/marcuspaulo/tutorial-publish-a-quarkus-application-in-kubernetes-minikube-and-dockerhub-36nd
+# Sources
+
+[Full documentation about deploying Quarkus application to Docker Hub](https://dev.to/marcuspaulo/tutorial-publish-a-quarkus-application-in-kubernetes-minikube-and-dockerhub-36nd)

docs/GITHUB_ACTIONS.md

@@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2021 Alliander N.V.
 SPDX-License-Identifier: CC-BY-4.0
 -->
 
-## Github Actions
+# Github Actions
 Every repository within the CoMPAS Github organization need a default set of Github Actions.
 [Github Actions](https://github.com/features/actions) are CI/CD steps within a Github Repository that you can configure. This way, you can ensure that certain steps (like building) are always triggered on for example a commit push.
 
@@ -18,7 +18,7 @@ More to follow.
 
 Github Actions are configured using YAML files. These files are stored in the `.github/workflows` directory of a specific repository.
 
-### Building
+## Building
 All source code repositories need some kind of building step.
 By default, all source code repositories use Maven as the build tool.
 
@@ -57,7 +57,7 @@ A few points to remember:
   check the [Contributing file](https://github.com/com-pas/contributing/blob/master/CONTRIBUTING.md).
 - (3): This is a default for building a Maven project. It may differ in some cases, please feel free to adjust it.
 
-### REUSE check
+## REUSE check
 For keeping our copyright and licensing information up to date and correct, we use [REUSE](https://reuse.software/) to check this. This is also configured for every separate repository in an easy manner: just create a `reuse.yml` file in the `.github/workflows` directory containing the following source code:
 
 ```yaml
@@ -79,7 +79,7 @@ A few points to remember:
 
 This is the only thing that has to be done. After this, it will be checked on every push.
 
-#### REUSE badge
+### REUSE badge
 For transparancy, CoMPAS repositories also include a REUSE badge in their README for fast checking the REUSE compliance.
 
 Two steps are needed to get a REUSE badge to work:
@@ -95,7 +95,7 @@ There is one steps left: Replace `repoName` with the name of the specific reposi
 
 After doing all these steps, everything is set up for the REUSE check.
 
-### SonarCloud
+## SonarCloud
 For static code analysis, CoMPAS is using [SonarCloud](https://sonarcloud.io/). To configure this, there are several steps that needs to be done.
 
 1. Go to the [CoMPAS Github organization settings](https://github.com/organizations/com-pas/settings/profile), and click on "Installed Github Apps". SonarCloud is listed here already (because we are already using it). Click on the 'configure' button next to it.
@@ -162,7 +162,7 @@ A few points to remember:
 
 Once this is set, it's all done!
 
-### Docker Hub Deployment
+## Docker Hub Deployment
 For automatic deployment of our microservices, CoMPAS uses Docker Hub as the central docker image repository. This way, all Docker images can be pulled from a central image repository.
 
 This step is easy to configure. Just create a `dockerhub_deployment.yml` file in the `.github/workflows` directory containing the following source code: