*: Fix files so that pre-commit passes

.github/ISSUE_TEMPLATE/bug-report.md

@@ -10,41 +10,33 @@ assignees: ''
 **meta-rte version**
 <!--(The version of meta-rte you're using (e.g., `v0.2.0`))-->
 
-
 **Affected component(s) or functionality**
 <!--(The component or functionality of the system that is not working as expected.)-->
 
-
 **Brief summary**
 <!--(A clear and concise summary of the bug.)-->
 
-
 **How reproducible**
 <!--(At what rate does the bug occur when the steps to reproduce are performed?)-->
 
-
 **How to reproduce**
 
 Steps to reproduce the behavior:
-1. 
-2. 
-3. 
+1.
+2.
+3.
 
 **Expected behavior**
 <!--(A clear and concise description of what you expected to happen.)-->
 
-
 **Actual behavior**
 <!--(What actually happened instead of what you expected to happen.)-->
 
-
 **Screenshots**
 <!--(If applicable, add screenshots to help explain your problem.)-->
 
-
 **Additional context**
 <!--(Add any other context about the problem here.)-->
 
-
 **Solutions you've tried**
 <!--(If applicable, any solutions or workarounds you've already tried.)-->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -10,18 +10,14 @@ assignees: ''
 **The problem you're addressing (if any)**
 <!--(A clear and concise description of the problem, if any, that this feature is intended to address.)-->
 
-
 **Describe the solution you'd like**
 <!--(If you have something in mind, a clear and concise description of what you want to happen. If you don't have something in mind, indicate as much.)-->
 
-
 **Where is the value to a user, and who might that user be?**
 <!--(Which users is this most likely to benefit? What user needs does this address? How might a user summarize this change or new thing?)-->
 
-
 **Describe alternatives you've considered**
 <!--(A clear and concise description of any alternative solutions or features you've considered.)-->
 
-
 **Additional context**
 <!--(Add any other context or screenshots about the feature request here.)-->

.github/ISSUE_TEMPLATE/question-or-support-request.md

@@ -10,7 +10,5 @@ assignees: ''
 **meta-rte version**
 <!--(The version of meta-rte you're using (e.g., `v0.2.0`))-->
 
-
 **Question text**
 <!--(Question text)-->
-

.github/ISSUE_TEMPLATE/task.md

@@ -10,15 +10,11 @@ assignees: ''
 **meta-rte version (if applicable)**
 <!--(The version of meta-rte you're using (e.g., `v0.2.0`))-->
 
-
 **Affected component(s) or functionality (if applicable)**
 <!--(If applicable, the component or functionality of the system that this task concerns.)-->
 
-
 **Brief summary**
 <!--(A clear and concise summary of the task that should be done.)-->
 
-
 **Additional context**
 <!--(Add any other context about the problem here.)-->
-

.markdownlintignore

@@ -0,0 +1 @@
+.github/ISSUE_TEMPLATE/**

README.md

@@ -1,5 +1,4 @@
-meta-rte
-========
+# meta-rte
 
 # Meta-RTE Yocto BSP documentation
 
@@ -28,14 +27,14 @@ inside container, via the [kas-container] script.
 
 * [kas-container] installation:
 
-```
+```sh
 wget -O ~/bin/kas-container https://raw.githubusercontent.com/siemens/kas/master/kas-container
 chmod +x ~/bin/kas-container
 ```
 
 ## Build
 
-```
+```sh
 mkdir rte-sdk
 cd rte-sdk
 git clone https://github.com/3mdeb/meta-rte.git
@@ -51,19 +50,19 @@ There are two main ways to flash an image, etcher and bmaptool.
 The easiest way to flash image on all system platforms is to use `etcher`. It
 is multi-platform application that is available for Linux, Windows or macOS.
 
-- Download and install [etcher](https://etcher.io/).
+* Download and install [etcher](https://etcher.io/).
 
-- Insert the SD card to the SD card reader of your host PC.
+* Insert the SD card to the SD card reader of your host PC.
 
-- Run etcher.
+* Run etcher.
 
-- Click on `Select Image` and select built image. There is no need to unpack
+* Click on `Select Image` and select built image. There is no need to unpack
 the image first.
 
    The SD card reader should be picked automatically. If more than one readers
    are present, click on `Change` and select the one you want to use.
 
-- When confirmed, click on the `Flash` button to start flashing procedure.
+* When confirmed, click on the `Flash` button to start flashing procedure.
 
 ### bmaptool
 
@@ -72,23 +71,25 @@ depending on the package manager your system uses, use one of the following
 commands:
 
 **for Ubuntu:**
-```
+
+```sh
 sudo apt install bmap-tools
 ```
 
 **for Fedora:**
-```
+
+```sh
 sudo dnf install bmap-tools
 ```
 
 you can then download the latest image from the
 [releases](https://github.com/3mdeb/meta-rte/releases) page. You should
 download both the `.wic.bmap` and `.wic.gz` files.
 
-Once you have chosen the version you want and downloaded it (both files), you can then
-flash it using bmaptool, like this:
+Once you have chosen the version you want and downloaded it (both files), you
+can then flash it using bmaptool, like this:
 
-```
+```sh
 bmaptool copy --bmap /path/to/example.wic.bmap /path/to/example.wic.gz /dev/sdX
 ```
 
@@ -99,7 +100,7 @@ what your SD card is called.
 
 ## Login to the system
 
-```
+```sh
 Login: root
 Password: meta-rte
 ```
@@ -110,28 +111,31 @@ To perform update on platform we will use
 [SWUpdate](https://sbabic.github.io/swupdate/index.html) software already
 installed on OS.
 
-- Download latest available .swu update image from [releases
+* Download latest available .swu update image from [releases
   page](https://github.com/3mdeb/meta-rte/releases).
 
-- Provide anyhow downloaded .swu update image to device, for example using scp
+* Provide anyhow downloaded .swu update image to device, for example using scp
+
   ```shell
   $ scp path/to/swu/file.swu root@RTE_IP:/path/to/deploy/file/
   ```
 
   >Note: you can check RTE_IP by running `ip a` command on RTE.
 
-- Check active partition, run `findmnt /` command on RTE
+* Check active partition, run `findmnt /` command on RTE
+
   ```shell
   # findmnt /
   TARGET SOURCE         FSTYPE OPTIONS
   /      /dev/mmcblk0p2 ext4   rw,relatime
   ```
 
-- Now run `swupdate` command, for flag `-e` we need to provide an inactive
+* Now run `swupdate` command, for flag `-e` we need to provide an inactive
   partition which in this case is `mmcblk0p3`. If `findmnt /` command would
   return `mmcblk0p3` then `mmcblk0p2` should be provided for `-e`. Flag `-i` is
   used to provide update image stored locally and `-v` will cause to print debug
   logs.
+
   ```shell
   # swupdate -e "rte,mmcblk0p3" -i /path/to/file.swu -v
   Swupdate v2020.04.0
@@ -144,8 +148,9 @@ installed on OS.
   [DEBUG] : SWUPDATE running :  [postupdate] : Running Post-update command
   ```
 
-- After success reboot the board. Platform should start from diferrent partition
+* After success reboot the board. Platform should start from different partition
   and updated system. This can be verified by running `cat /etc/os-release`.
+
   ```shell
   # cat /etc/os-release
   ID=rte
@@ -155,7 +160,7 @@ installed on OS.
   PRETTY_NAME="RTE (Remote Test Environment Distro) 0.7.4-rc1 (rocko)"
   ```
 
-- From now, updated partition will be set as active, so every next reboot will
+* From now, updated partition will be set as active, so every next reboot will
   cause to boot updated OS.
 
 ## OpenVPN
@@ -169,13 +174,13 @@ SD card with the name `rte.conf`.
 You can access the DUT's serial connection from the RS232/UART port at
 `/dev/ttyS1`, for example, through Minicom:
 
-```
+```sh
 # minicom -D /dev/ttyS1
 ```
 
 All possible devices can be listed using following command:
 
-```
+```sh
 # ls /dev/tty*
 ```
 
@@ -185,14 +190,14 @@ It is also possible to use telnet communication via RTE. On RTE there is serial
 to network proxy service called `ser2net`. Its status can be seen by running a
 command:
 
-```
+```sh
 # systemctl -all | grep ser2net
   ser2net.service           loaded     active     running
 ```
 
 Service configuration is placed here:
 
-```
+```sh
 # cat /etc/ser2net.conf
 13542:telnet:16000:/dev/ttyS1:115200 8DATABITS NONE 1STOPBIT
 13541:telnet:16000:/dev/ttyUSB0:115200 8DATABITS NONE 1STOPBIT
@@ -203,13 +208,13 @@ indicates the path to the device with which the connection is made.
 
 Serial connection with the device can be established by command:
 
-```
+```sh
 $ telnet <RTE_IP> <PORT>
 ```
 
 for example:
 
-```
+```sh
 $ telnet 192.168.4.170 13541
 ```
 

docs/development.md

@@ -1,5 +1,4 @@
-RTE Yocto - Development process description
-------------------------
+# RTE Yocto - Development process description
 
 ## Intro
 
@@ -15,7 +14,7 @@ repository. Tags in this repository correspond to the releases of the whole
 `RTE Yocto BSP`. The content (meta layers and their revisions) of given
 `RTE Yocto BSP` release is defined by the
 [kas file](https://gitlab.com/3mdeb/rte/meta-rte/blob/master/kas.yml).
-Desciption of kas file add project configuration can be found
+Description of kas file add project configuration can be found
 [here](https://kas.readthedocs.io/en/0.19.0/userguide.html#project-configuration).
 
 ## Prerequisites
@@ -31,8 +30,8 @@ Minimal recommended hardware is:
 
 ### Software requirements
 
-* Linux distribution with [Docker](https://docs.docker.com/install/) installed
-* [kas](https://github.com/siemens/kas) installed. The preferred way is to use
+- Linux distribution with [Docker](https://docs.docker.com/install/) installed
+- [kas](https://github.com/siemens/kas) installed. The preferred way is to use
 it inside container, via the
 [kas-docker script](https://github.com/siemens/kas/blob/master/kas-docker).
 Check [meta-rte prerequisites](https://gitlab.com/3mdeb/rte/meta-rte#prerequisites)
@@ -45,7 +44,7 @@ in `meta-rte` repository.
 
 ### Building images
 
-```
+```sh
 mkdir rte-sdk
 cd rte-sdk
 git clone [email protected]:3mdeb/rte/meta-rte.git
@@ -56,7 +55,7 @@ It will clone layers defined in `kas file`, set up everything and build
 recipes defined in `target` section in kas file. After the `RTE Yocto BSP` has
 been set up, the `rte-sdk` content can look like:
 
-```
+```sh
 rte-sdk
 ├── build
 ├── meta-openembedded
@@ -77,10 +76,9 @@ built images) can be found in `build/tmp/deploy/images/orange-pi-zero`.
 is a set of metadata to build given component. A recipe can build be used to
 build a small package, Linux kernel, or even the whole image.
 
-
 Alternatively, you can invoke usual bitbake steps manually, e.g.:
 
-```
+```sh
 SHELL=bash kas-docker --ssh-dir ~/.ssh/ssh-keys shell meta-rte/kas.yml -c 'bitbake core-image-minimal-swu'
 ```
 
@@ -92,4 +90,4 @@ shown above.
 Once you are familiar with the `RTE Yocto - Development process description`,
 you can continue with the:
 
-* [release process](release.md)
+- [release process](release.md)