Start with Markdownlint fro vscode editing. Initial linting error fix…

…es. (#1377) Signed-off-by: Jerome Luckenbach <[email protected]>
openhab · Dec 25, 2020 · 953e074 · 953e074
1 parent 9a642df
commit 953e074
Show file tree

Hide file tree

Showing 10 changed files with 132 additions and 83 deletions.
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,8 @@
+{
+    "default": true,
+    "MD004": {
+        "style": "dash"
+    },
+    "MD013": false,
+    "MD025": false
+}
diff --git a/installation/armbian.md b/installation/armbian.md
@@ -23,13 +23,11 @@ Armbian is a base operating system platform for single board computers.
 
 OpenHab will run on any Armbian [supported hardware](https://www.armbian.com/download/?device_support=Supported) but it is recommended to choose boards that have at least:
 
-
 - 512 Kb of memory (on minimal or server image)
 - eMMC or a [quality SD card](https://docs.armbian.com/User-Guide_Getting-Started/#how-to-prepare-a-sd-card)
 - 4 core
 - wired networking
 
-
 ![Armbian](images/boards1.png)
 
 ## Supported images
@@ -42,14 +40,14 @@ You can [download](https://www.armbian.com/download/?device_support=Supported) a
 
 1. Prepare Armbian as usual - [login as root / 1234, change root password, create username. You don't need to perform any other steps](https://docs.armbian.com/User-Guide_Getting-Started/).
 
-2. Update
+1. Update
 
 ```shell
 sudo apt-get update
 sudo apt-get upgrade
 ```
 
-3. Run armbian-config
+1. Run armbian-config
 
 ```shell
 sudo armbian-config

diff --git a/installation/docker.md b/installation/docker.md
@@ -166,6 +166,7 @@ Finally run `sudo systemctl start openhab2.service` to start openHAB running.
 ## Explanation of Arguments Passed to Docker
 
 Note, always review the README on [Docker Hub](https://hub.docker.com/r/openhab/openhab/) for the most up to date set of recommended arguments and environment variables.
+
 - `/usr/bin/docker run` : create a new container from the passed in Image (last argument)
 - `--name=openhab` : give the container a human remember able name
 - `--net=host` : by default Docker will place a container into its own network stack. However, openHAB requires UPnP discovery so this parameter makes the Docker container use the host's network stack.
@@ -238,7 +239,6 @@ docker exec \
     /bin/chmod o+rw /dev/ttyACM0
 ```
 
-
 This command changes permissions of the specific device as expected (readable and writable for everyone).
 
 ::: tip Note

diff --git a/installation/index.md b/installation/index.md
@@ -17,10 +17,10 @@ Always keep this in mind when searching for help and solutions.
 
 ## Platform Recommendations
 
-1.  You are **new to openHAB** and want to give it a try? You are in luck:
+1. You are **new to openHAB** and want to give it a try? You are in luck:
     - Set up openHAB on your local PC or Mac in just a few steps.
 
-1.  You've gained some experience and want to use openHAB to seriously control your home?
+1. You've gained some experience and want to use openHAB to seriously control your home?
     Typical hardware and software requirements are:
     - **24/7 availability:** A dedicated system connected by Ethernet and running continuously.
     - **Energy and space efficient:** A device capable of performing the task at hand without being excessive for your needs.
@@ -74,12 +74,12 @@ OpenJDK 64-Bit Server VM Zulu11.43+55-CA (build 11.0.9.1+1-LTS, mixed mode)
 
 Before you can start, two decisions have to be made:
 
-1.  openHAB is available as a platform independent archive file or through a package repository:
+1. openHAB is available as a platform independent archive file or through a package repository:
     - **Manual setup:** Download and extract a platform independent zip archive: [macOS](macos.html), [Windows](windows.html), [Linux](linux.html#manual-installation)
     - **Package setup:** Install from a package repository, using a package manager such as apt or yum.
     This option is only available for certain Linux distributions such as Debian or Ubuntu derivatives, but allows you to take advantage of automatic updates and is the recommended choice: [Linux (apt/deb)](linux.html#package-repository-installation)
 
-2.  Stable release or cutting edge:
+2. Stable release or cutting edge:
     - **Stable:** Use the latest official release [hosted on Bintray](https://bintray.com/openhab/mvn/openhab-distro) (recommended for new users).
     - **Snapshot:** Benefit from the latest changes in the daily created snapshot ([hosted on openhab.org](https://ci.openhab.org/)).
 
@@ -91,9 +91,9 @@ Please follow the instructions in the installation article matching your platfor
 
 After you get openHAB set up and running, there are a few additional setup steps you should consider:
 
--   Configure a network share on your openHAB host system using [Linux Samba Share](linux.html#network-sharing) for easier remote editing of configuration files.
+- Configure a network share on your openHAB host system using [Linux Samba Share](linux.html#network-sharing) for easier remote editing of configuration files.
 
--   Install [Visual Studio Code](https://code.visualstudio.com/Download) and the [openHAB VS Code Extension]({{base}}/configuration/editors.html#openhab-vs-code-extension) on your local machine, to manage your (remote) configuration files.
+- Install [Visual Studio Code](https://code.visualstudio.com/Download) and the [openHAB VS Code Extension]({{base}}/configuration/editors.html#openhab-vs-code-extension) on your local machine, to manage your (remote) configuration files.
     The openHAB VS Code Extension comes with built-in support for the openHAB syntax and elements.
 
 ## Getting started

diff --git a/installation/linux.md b/installation/linux.md
@@ -27,7 +27,8 @@ Linux file permissions is one of the biggest sources of issues, Linux novices ru
 If you find yourself in a situation, where you have **no write access** to the openHAB configuration or system files wrong permissions and/or the incorrect use of `sudo` are often the cause.
 Train your understanding of Linux permissions at [linuxjourney.com/lesson/file-permissions](https://linuxjourney.com/lesson/file-permissions).
 
-## Meeting the Requirements: ##
+## Meeting the Requirements
+
 As a first step, please verify, that your system meets the [prerequisites](index.html#prerequisites).
 You may want to install Zulu, a fully certified Java build [as a package or manually](https://docs.azul.com/zulu/zuludocs/ZuluUserGuide/InstallingZulu/InstallZulu.htm).
 
@@ -43,9 +44,10 @@ Make sure to download Zulu or Java **11**.
 ## Installation
 
 openHAB can be installed through
- - the openHABian project **(easiest method, ships with the openHABian configuration tool)**
- - a package repository (apt, yum)
- - manually from file.
+
+- the openHABian project **(easiest method, ships with the openHABian configuration tool)**
+- a package repository (apt, yum)
+- manually from file.
 
 The installation through the **openHABian project** and the use of the provided openHABian configuration tool is recommended for end users.
 
@@ -54,6 +56,7 @@ Installing using the provided **package repository** (using `apt`, `apt-get`, `y
 The manual installation through a platform independent archive file is suited for users who know what they are doing.
 
 ### openHABian project
+
 The easy step by step instruction can be found [here](openhabian.html).
 
 ### Package Repository Installation
@@ -77,7 +80,7 @@ sudo apt-get install apt-transport-https
 
 Then, you can choose between, *Official (Stable)*, *Beta* or *Snapshot* builds:
 
--   **Stable Release**
+- **Stable Release**
 
     The stable builds contain the latest official release with tested features.
 
@@ -87,7 +90,7 @@ Then, you can choose between, *Official (Stable)*, *Beta* or *Snapshot* builds:
     echo 'deb https://dl.bintray.com/openhab/apt-repo2 stable main' | sudo tee /etc/apt/sources.list.d/openhab.list
     ```
 
--   **Testing Release**
+- **Testing Release**
 
     The beta and release candidate builds come out less frequently, but will contain new features that are currently in the testing phase.
 
@@ -97,7 +100,7 @@ Then, you can choose between, *Official (Stable)*, *Beta* or *Snapshot* builds:
     echo 'deb https://openhab.jfrog.io/artifactory/openhab-linuxpkg testing main' | sudo tee /etc/apt/sources.list.d/openhab.list
     ```
 
--   **Snapshot Release**
+- **Snapshot Release**
 
     The snapshot build is created [almost daily](https://ci.openhab.org/job/openhab-linuxpkg/), and include the latest changes to the openHAB core and add-ons.
     These changes are often unstable, so you should use this branch only for testing or development purposes.
@@ -138,7 +141,7 @@ sudo apt-get install openhab-addons
 The RPM repo information should be defined inside a file, make a new file at `/etc/yum.repos.d/openhab.repo` with the following contents depending on your choice of release.
 You may add all three to the same file, but make sure the desired repo is is set to `enabled=1`:
 
--   **Stable Release**
+- **Stable Release**
 
     The stable builds contain the latest official release with tested features.
 
@@ -151,7 +154,7 @@ You may add all three to the same file, but make sure the desired repo is is set
     enabled=1
     ```
 
--   **Testing Release**
+- **Testing Release**
 
     The beta or release candidate builds come out less frequently, but will contain new features that are currently in the testing phase.
 
@@ -164,7 +167,7 @@ You may add all three to the same file, but make sure the desired repo is is set
     enabled=1
     ```
 
--   **Snapshot Release**
+- **Snapshot Release**
 
     The snapshot build is created [almost daily](https://ci.openhab.org/job/openhab-linuxpkg/), and include the latest changes to the openHAB core and add-ons.
     These changes are often unstable, so you should use this branch only for testing or development purposes.
@@ -260,7 +263,7 @@ sudo systemctl enable openhab.service
 
 The first start may take **up to 15 minutes**, this is a good time to reward yourself with hot coffee or a freshly brewed tea!
 
-You should be able to reach the openHAB Dashboard at [http://openhab-device:8080]() at this point.
+You should be able to reach the openHAB Dashboard at `http://openhab-device:8080` at this point.
 If you're new to openHAB, then you should checkout the [beginner's tutorial]({{base}}/tutorial/first_steps.html)!
 
 ![The openHAB Dashboard page](images/Home_Openhab_3.png)
@@ -450,7 +453,7 @@ We are going to download a platform independent archive file and extract it to t
 Choose between the latest Beta release or a Snapshot with all incoming contributions, created daily.
 As openHAB is still in an evolving state, the snapshot may be the **preferred choice**.
 
--   **Official Release**
+- **Official Release**
 
     Download and extract the latest offical stable version of openHAB from [our downloadpage](https://www.openhab.org/download/) to your host:
 
@@ -461,11 +464,11 @@ As openHAB is still in an evolving state, the snapshot may be the **preferred ch
     rm openhab-download.zip
     ```
 
--   **Beta/RC Release**
+- **Beta/RC Release**
 
     If available, beta or release candidate builds of openHAB can also be downloaded from [our downloadpage](https://www.openhab.org/download/) and extracted to your host as shown above.
 
--   **Snapshot Release**
+- **Snapshot Release**
 
     Download and extract the latest snapshot version of openHAB from [our downloadpage](https://www.openhab.org/download/) to your host. The process is analogue to above.
 
@@ -477,7 +480,7 @@ sudo chown -hR openhab:openhab /opt/openhab
 ```
 
 Everything is ready for a first test run.
-**Execute** openHAB and you should be able to reach the openHAB Dashboard at [http://openhab-device:8080]() after a few minutes:
+**Execute** openHAB and you should be able to reach the openHAB Dashboard at `http://openhab-device:8080` after a few minutes:
 
 ```shell
 # execute as restricted user openhab:
@@ -563,7 +566,7 @@ This is especially important if you are working with the latest snapshot as chan
 openHAB uses a script to update to any other version, or from stable to snapshot and visa-versa.
 Your personal configuration will be retained on upgrades, but you should **stop openHAB** and perform a backup first.
 
--   **Versions 2.1.0 and Above**
+- **Versions 2.1.0 and Above**
 
     From version 2.1.0, openHAB is distributed with the update script included.
     This script should be called from within openHAB's root directory.
@@ -587,7 +590,7 @@ Your personal configuration will be retained on upgrades, but you should **stop
     sudo runtime/bin/update 2.2.0-SNAPSHOT
     ```
 
--   **Older Versions**
+- **Older Versions**
 
     If you're using a version earlier than 2.1.0, then you can use the following commands in Terminal to download the script and run it.
     Assuming the openHAB directory is in `/opt/openhab`:
@@ -732,7 +735,7 @@ Next, add the desired share configurations to the end of the file:
 
 <!-- TODO: Limit to configuration folder??? -->
 
--   Package repository based installation:
+- Package repository based installation:
 
     ```ini
     [openHAB-userdata]
@@ -766,7 +769,7 @@ Next, add the desired share configurations to the end of the file:
       directory mask=0777
     ```
 
--   Manual installation:
+- Manual installation:
 
     ```ini
     [openHAB-files]

diff --git a/installation/macos.md b/installation/macos.md
@@ -23,16 +23,16 @@ If you're unfamiliar with using the macOS terminal, then feel free to follow the
 openHAB is packaged as a platform independent `zip` archive. Installation is as simple as unziping it into a unique folder.
 First, make sure that your system meets the [prerequisites](index.html#prerequisites).
 When you are running macOS BigSur or higher, make sure
-that you select the right platform depending on your hardware (x86 or ARM 64-bit). 
+that you select the right platform depending on your hardware (x86 or ARM 64-bit).
 
 You have the choice to use the current stable version or the latest snapshot build:
 
--   **Stable**
+- **Stable**
 
     The stable builds have undergone testing, it is the recommended version to download.
     Download the latest `openhab-3.x.x.zip` [here](https://www.openhab.org/download/).
 
--   **Snapshot (Unstable)**
+- **Snapshot (Unstable)**
 
     Snapshots are built daily, and contain the latest changes to openHAB's source code.
     These changes haven't undergone the same amount of testing as the stable releases, so only use them if you **need** a new feature.
@@ -79,11 +79,11 @@ The first run may take a while to process, wait until the "`openhab>`" prompt ap
 $ ./start.sh
 Launching the openHAB runtime...
 
-                           _   _     _     ____  
-   ___   ___   ___   ___  | | | |   / \   | __ ) 
-  / _ \ / _ \ / _ \ / _ \ | |_| |  / _ \  |  _ \ 
+                           _   _     _     ____
+   ___   ___   ___   ___  | | | |   / \   | __ )
+  / _ \ / _ \ / _ \ / _ \ | |_| |  / _ \  |  _ \
  | (_) | (_) |  __/| | | ||  _  | / ___ \ | |_) )
-  \___/|  __/ \___/|_| |_||_| |_|/_/   \_\|____/ 
+  \___/|  __/ \___/|_| |_||_| |_|/_/   \_\|____/
        |_|       3.0.0 - Release Build
 
 Use '<tab>' for a list of available commands
@@ -94,7 +94,7 @@ To exit, use '<ctrl-d>' or 'logout'.
 openhab>
 ```
 
-Without closing the terminal, open your favorite web browser and type the following URL: [http://localhost:8080](http://localhost:8080), you should see the openHAB welcome screen, and you're all set to [using openHAB]({{base}}/tutorial/first_steps.html). 
+Without closing the terminal, open your favorite web browser and type the following URL: [http://localhost:8080](http://localhost:8080), you should see the openHAB welcome screen, and you're all set to [using openHAB]({{base}}/tutorial/first_steps.html).
 If you installed openHAB on a different device, replace localhost with the IP address of the device.
 
 ## Updating openHAB

diff --git a/installation/qnap.md b/installation/qnap.md
@@ -2,7 +2,7 @@
 layout: documentation
 title: QNAP NAS
 ---
- 
+
 {% include base.html %}
 
 # QNAP NAS
@@ -17,44 +17,44 @@ Please find all details about the openHAB package for QNAP [here](https://github
 Check that your NAS has the most recent firmware version.
 Follow the instructions shown if a new version is announced when opening the admin GUI.
 
-1.  Download the QPKG from the [releases section over on GitHub](https://github.com/openhab/openhab-qnap-qpkg/releases).
+1. Download the QPKG from the [releases section over on GitHub](https://github.com/openhab/openhab-qnap-qpkg/releases).
 
-2.  Create a directory for your addons, configurations and userdata, by either
+2. Create a directory for your addons, configurations and userdata, by either
     - Creating a share called "openHAB" (recommended)
     - Creating a folder called "openHAB" inside the "Public" share
     - Not creating any of them and therefore using `.qpkg/openHAB2/distribution` for all data (for testing or demonstration)
 
-3.  Go to your NAS's App Center and make sure you have got "JRE" (for x86-CPU based NAS) or "JRE_ARM" (for ARM-CPU based NAS) installed.
+3. Go to your NAS's App Center and make sure you have got "JRE" (for x86-CPU based NAS) or "JRE_ARM" (for ARM-CPU based NAS) installed.
     If that is not the case, go to the "Developer-Tools" section of the App Center, install the appropriate version and wait for a while until the Java installation has finished.
 
-4.  Open the "Install manually" dialog in the App Center by clicking the gear-wheel on the upper-right corner of the App Center and choose the `qpkg` you have downloaded.
+4. Open the "Install manually" dialog in the App Center by clicking the gear-wheel on the upper-right corner of the App Center and choose the `qpkg` you have downloaded.
 
     ![AppCenter choose](https://github.com/openhab/openhab-qnap-qpkg/raw/master/docs/QTS_4.2.0_AppCenter%20choose.png)
 
-5.  Confirm the installation
+5. Confirm the installation
 
     ![AppCenter confirm](https://github.com/openhab/openhab-qnap-qpkg/raw/master/docs/QTS_4.2.0_AppCenter%20confirm.png)
 
-6.  Wait while the package is being installed
+6. Wait while the package is being installed
 
     ![AppCenter installing](https://github.com/openhab/openhab-qnap-qpkg/raw/master/docs/QTS_4.2.0_AppCenter%20installing.png)
 
-7.  When finished just close the dialog and wait for a while until openHAB has completely started.
+7. When finished just close the dialog and wait for a while until openHAB has completely started.
     This may take several minutes.
 
     ![AppCenter finished](https://github.com/openhab/openhab-qnap-qpkg/raw/master/docs/QTS_4.2.0_AppCenter%20finished.png)
 
-8.  Access openHAB via "[http://NAS_IP_or_DNS_address:8090](#)".
+8. Access openHAB via `http://NAS_IP_or_DNS_address:8090`.
     If the interface does not start, retry after another minute.
     The initial startup takes some time.
 
 ## How to uninstall
 
 If you want to keep configuration files, copy them to a save place outside of the openhab-path.
 
-1.  Go to the "App Center" and remove the app like any other.
+1. Go to the "App Center" and remove the app like any other.
 
-2.  Additionally if wanted or needed, please remove the folders "addons", "conf" and "userdata" from the your directory, eg. "openHAB2" share or "Public"/openHAB2
+2. Additionally if wanted or needed, please remove the folders "addons", "conf" and "userdata" from the your directory, eg. "openHAB2" share or "Public"/openHAB2
    If you have installed openHAB2 to `.qpkg` (see "How to install", third option) then all files get removed automatically.
 
 ## Known issues