openhab
diff --git a/‎.github/markdownStyle.rb
Lines changed: 0 additions & 19 deletions b/‎.github/markdownStyle.rb
Lines changed: 0 additions & 19 deletions
diff --git a/‎.github/workflows/brokenLinkCheck.yml
Lines changed: 18 additions & 0 deletions b/‎.github/workflows/brokenLinkCheck.yml
Lines changed: 18 additions & 0 deletions
diff --git a/‎.github/workflows/markdownlint.yml
Lines changed: 17 additions & 10 deletions b/‎.github/workflows/markdownlint.yml
Lines changed: 17 additions & 10 deletions
diff --git a/‎.markdownlint.json
Lines changed: 0 additions & 7 deletions b/‎.markdownlint.json
Lines changed: 0 additions & 7 deletions
diff --git a/‎.markdownlint.yaml
Lines changed: 27 additions & 0 deletions b/‎.markdownlint.yaml
Lines changed: 27 additions & 0 deletions
diff --git a/‎.vuepress/add_placeholders.rb
Lines changed: 5 additions & 3 deletions b/‎.vuepress/add_placeholders.rb
Lines changed: 5 additions & 3 deletions
diff --git a/‎.vuepress/docs-sidebar.js
Lines changed: 3 additions & 1 deletion b/‎.vuepress/docs-sidebar.js
Lines changed: 3 additions & 1 deletion
diff --git a/‎.vuepress/process_file.rb
Lines changed: 5 additions & 11 deletions b/‎.vuepress/process_file.rb
Lines changed: 5 additions & 11 deletions
diff --git a/‎.vuepress/process_main_docs.rb
Lines changed: 1 addition & 1 deletion b/‎.vuepress/process_main_docs.rb
Lines changed: 1 addition & 1 deletion
diff --git a/‎CONTRIBUTING.md
Lines changed: 12 additions & 13 deletions b/‎CONTRIBUTING.md
Lines changed: 12 additions & 13 deletions
diff --git a/‎README.md
Lines changed: 2 additions & 2 deletions b/‎README.md
Lines changed: 2 additions & 2 deletions
@@ -0,0 +1,18 @@
+name: Check for broken links
+
+# https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/
+
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+
+  markdown-link-check:
+
+    name: Check for broken links
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
@@ -1,16 +1,22 @@
-name: Linting
+name: Checking Markdown For Errors
+
+# https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/
 
 on:
   push:
     branches:
-      - 'main'
-      - '2.5.x'
+      - main
+      - 2.5.x
     tags-ignore:
       - '**'
-#  pull_request:
-#    branches:
-#      - main
-#    types: [open,synchronize,reopen]
+
+  pull_request:
+    branches:
+      - main
+    types:
+      - open
+      - synchronize
+      - reopen
 
 jobs:
   markdownlint:
@@ -20,7 +26,8 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v2
 
-      - name: Run markdownlint (mdl)
-        uses: bewuethr/mdl-action@v1.0.12
+      - name: Run markdownlint-cli
+        uses: Confectrician/github-action-markdown-cli@v2.0.0
         with:
-          style-file: .github/markdownStyle.rb
+          files: .
+          config_file: ".markdownlint.yaml"
@@ -0,0 +1,27 @@
+default: true
+
+# Expect dash usage for unorderd lists
+MD004:
+    style: dash
+
+# Allow long line lengths
+MD013: false
+
+# Allow duplicate headers for different nesting
+MD024:
+    allow_different_nesting: true
+
+# Allow Multiple top level headers in the same document
+MD025: false
+
+# Allow trailing punctuation in headers
+MD026: false
+MD029:
+    style: one
+
+# Allow inline HTML
+MD033: false
+
+# Code block style
+MD046:
+    style: fenced
@@ -3,19 +3,21 @@
 def add_placeholder_pages()
     puts ">>> Adding placeholder pages for preview"
     [
+        "addons/integrations/homekit",
+        "docs/apps/android.md",
         "docs/configuration/iconsets/classic",
         "docs/configuration/ui/habmin",
         "docs/configuration/ui/habot",
+        "docs/configuration/ui/habpanel",
         "docs/configuration/ui/basic",
         "docs/configuration/ui/classic",
         "docs/ecosystem/alexa",
         "docs/ecosystem/google-assistant",
         "docs/ecosystem/ifttt",
         "docs/ecosystem/mycroft",
-        "addons/integrations/homekit",
+        "docs/installation/openhabian.md",
         "link/homekit",
-        "link/openhabcloud",
-        "docs/apps/android.md"
+        "link/openhabcloud"
     ].each { |path|
         puts " -> #{path}"
         page = path
 
@@ -84,14 +84,16 @@ module.exports = [
       'configuration/habpanel',
       ['configuration/ui/basic/', 'Basic UI'],
       ['configuration/restdocs', 'REST API'],
+      ['configuration/apitokens', 'API Token Generation'],
       ['apps/android', 'Android App'],
       'apps/ios',
       'apps/windows',
       ['ecosystem/alexa/', 'Amazon Alexa'],
       ['ecosystem/google-assistant/', 'Google Assistant'], // from v2.3 onwards
-      ['../addons/integrations/homekit/', 'Apple HomeKit'],
+      ['../link/homekit/', 'Apple HomeKit'],
       // ['ecosystem/ifttt/', 'IFTTT'], // Temporary remove until service gets reactivated
       ['ecosystem/mycroft/', 'Mycroft.AI'],
+      ['../link/openhabcloud/', 'openHAB Cloud'],
     ]
   },
   {
 
@@ -57,24 +57,18 @@ def process_file(indir, file, outdir, source)
                             addon_type = outdir_parts[1]
                             addon = file.split('/')[0]
                             source = ""
-                            if addon == "habmin" then
-                                puts "    (add-on is habmin)"
-                                source = "https://github.com/openhab/org.openhab.ui.habmin/blob/master/README.md"
-                            elsif addon == "habpanel" then
+                            if addon == "habpanel" then
                                 puts "    (add-on is habpanel)"
-                                source = "https://github.com/openhab/org.openhab.ui.habpanel/blob/master/README.md"
+                                source = "https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui.habpanel/README.md"
                             elsif addon == "zigbee" then
                                 puts "    (add-on is zigbee)"
-                                source = "https://github.com/openhab/org.openhab.binding.zigbee/blob/master/org.openhab.binding.zigbee/README.md"
+                                source = "https://github.com/openhab/org.openhab.binding.zigbee/blob/main/org.openhab.binding.zigbee/README.md"
                             elsif addon == "zwave" && !(file =~ /things/) then
                                 puts "    (add-on is zwave)"
-                                source = "https://github.com/openhab/org.openhab.binding.zwave/blob/master/README.md"
-                            elsif $esh_features.include?("esh-#{addon_type}-#{addon.gsub('.', '-')}") then
-                                puts "    (add-on is from ESH)"
-                                source = "https://github.com/eclipse/smarthome/blob/master/extensions/#{addon_type}/org.eclipse.smarthome.#{addon_type}.#{addon}/README.md"
+                                source = "https://github.com/openhab/org.openhab.binding.zwave/blob/main/README.md"
                             elsif !(file =~ /things/) then
                                 puts "    (add-on is from openhab-addons)"
-                                source = "https://github.com/openhab/openhab-addons/blob/master/addons/#{addon_type}/org.openhab.#{addon_type}.#{addon}/README.md"
+                                source = "https://github.com/openhab/openhab-addons/blob/main/addons/#{addon_type}/org.openhab.#{addon_type}.#{addon}/README.md"
                             end
 
                             out.puts "source: #{source}" if source != ""
 
@@ -3,7 +3,7 @@
 def process_main_docs(docs_source_dir)
 
     puts ">>> Migrating the introduction article"
-    process_file(".", "introduction.md", "docs", "https://github.com/openhab/openhab-docs/blob/master/introduction.md")
+    process_file(".", "introduction.md", "docs", "https://github.com/openhab/openhab-docs/blob/main/introduction.md")
     FileUtils.mv("docs/introduction.md", "docs/readme.md")
 
 
 
@@ -1,12 +1,12 @@
 # Contribution Guidelines
 
-### Pull requests are always welcome
+## Pull requests are always welcome
 
 We are always thrilled to receive pull requests, and do our best to
 process them as fast as possible. Not sure if that typo is worth a pull
 request? Do it! We will appreciate it.
 
-### Conventions
+## Conventions
 
 Fork the repo and make changes on your fork in a feature branch.
 
@@ -28,15 +28,15 @@ comment.
 Commits that fix or close an issue should include a reference like `Closes #XXX`
 or `Fixes #XXX`, which will automatically close the issue when merged.
 
-### Sign your work
+## Sign your work
 
 The sign-off is a simple line at the end of the explanation for the
 patch, which certifies that you wrote it or otherwise have the right to
 pass it on as an open-source patch.  The rules are pretty simple: if you
 can certify the below (from
 [developercertificate.org](https://developercertificate.org/)):
 
-```
+```text
 Developer Certificate of Origin
 Version 1.1
 
@@ -77,42 +77,41 @@ By making a contribution to this project, I certify that:
 
 then you just add a line to every git commit message:
 
-    Signed-off-by: Joe Smith <[email protected]>
+`Signed-off-by: Joe Smith <[email protected]>`
 
 using your real name (sorry, no pseudonyms or anonymous contributions.) and an
 e-mail address under which you can be reached (sorry, no github noreply e-mail
 addresses (such as [email protected]) or other non-reachable
 addresses are allowed).
 
-#### Small patch exception
+### Small patch exception
 
 There are several exceptions to the signing requirement. Currently these are:
 
-* Your patch fixes spelling or grammar errors.
-* Your patch is a single line change to documentation.
+- Your patch fixes spelling or grammar errors.
+- Your patch is a single line change to documentation.
 
 ## Community Guidelines
 
 We want to keep the openHAB community awesome, growing and collaborative. We
 need your help to keep it that way. To help with this we've come up with some
 general guidelines for the community as a whole:
 
-* Be nice: Be courteous, respectful and polite to fellow community members: no
+- Be nice: Be courteous, respectful and polite to fellow community members: no
   regional, racial, gender, or other abuse will be tolerated. We like nice people
   way better than mean ones!
 
-* Encourage diversity and participation: Make everyone in our community
+- Encourage diversity and participation: Make everyone in our community
   feel welcome, regardless of their background and the extent of their
   contributions, and do everything possible to encourage participation in
   our community.
 
-* Keep it legal: Basically, don't get us in trouble. Share only content that
+- Keep it legal: Basically, don't get us in trouble. Share only content that
   you own, do not share private or sensitive information, and don't break the
   law.
 
-* Stay on topic: Make sure that you are posting to the correct channel
+- Stay on topic: Make sure that you are posting to the correct channel
   and avoid off-topic discussions. Remember when you update an issue or
   respond to an email you are potentially sending to a large number of
   people.  Please consider this before you update.  Also remember that
   nobody likes spam.
-
@@ -18,7 +18,7 @@ We will read about them later.
 Correct, this is done in the original repository of the add-on.
 You may want to know how to find the right file in all of those repos?
 This is fairly easy:
-on most of the documentation pages on https://openhab.org/,
+on most of the documentation pages on <https://openhab.org/>,
 you will find the following link at the bottom, which will point you directly to the file you want to improve.
 
 ![Contribution link to a specific page](./images/contribution_link.png)
@@ -96,4 +96,4 @@ In short, the following has to be considered:
 - Versions like "2.1.0" are marked by git tags.
 - Based on tags branches like "2.1-patch" are created, to include later discovered changes (like fixed links).
 
-When a version is tagged (or updated), a static version of the website has to be generated and copied into the correct sub-folder, this is currently a manual operation described succinctly here: https://github.com/openhab/website/issues/72
+When a version is tagged (or updated), a static version of the website has to be generated and copied into the correct sub-folder, this is currently a manual operation described succinctly here: <https://github.com/openhab/website/issues/72>