Resolve merge conflicts / Fix CI builds (#1472)

* Apply bulk automated corrections. 🔧(#1433) Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Added sidebar links. (#1434) * Added sidebar links. * Introduce openhabian placeholder page. * Remove local version of openhabian doc page. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Fix linter errors 🔧(#1435) * Fix errros for the addon folder. * Fix errros for the administration folder. * Fix errros for the concepts folder. * Fix errros for the configuration folder. * Improved and synced markdown linting rules. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Revert #1428 (#1436) Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Fix linter errors. 🔧(#1437) Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Bulk edit linter errors. (#1438) * Bulk edit linter errors. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Fix linter style Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Fix linter errors (#1439) * Some leftover linting error fixes. * Adapt rules and enble markdownlint for pull requests. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Fix markdownlint workflow Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Fixes for linter errors and markdown configuration. (#1440) Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Update guidelines.md (#1441) Only a maintainer told me how to tackle a DTO properly as a class. As I did not see this anywhere, I decide to make this change. * Add fixes from markdownlint-cli (#1442) Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Switch to markdown cli action (#1443) * Fix left markdownlint errors. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Change to markdownlint-cli action. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Update markdownlint.yml Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Move trigger order Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Make pr check available for markdownlint 📝 (#1446) * Make pr check available for markdownlint (hopefully). Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Add link check action. (#1449) * Add link check action. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Add blank line. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Replace local urls with inline code. Change one occurence to openhabian. (#1450) Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * remove uncessary instructions f. contribution guide (#1454) * Update items.md (#1455) Example with item Switch Kitchen_Light in the example is not correct for current binding version. * Created API token docs (#1453) * Created API token docs Signed-off-by: Gerwin Lammers <gerwinlammers@gmail.com> * Update after review session Signed-off-by: Gerwin Lammers <gerwinlammers@gmail.com> * Add new page to sidebar navigation. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Co-authored-by: Jerome Luckenbach <github@luckenba.ch> * Update rules-dsl.md (#1456) * Update rules-dsl.md Corrected the "system started" section to reflect that the trigger will no longer execute on loading the rules file in OH v.3. * Adapt inline codeblock design. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Co-authored-by: Jerome Luckenbach <github@luckenba.ch> * Remove paper ui references. (#1457) * Remove paper uii references. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Fix Markdown errors. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Remove target param from markdownlint pr trigger. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Update items.md (#1458) There is one comma too much in the sample for profile hysteresis. The profile must be related to the channel. The comma will lead also to an error message in log. Switch Low_Battery { channel="serialbutton:button:mybutton:battery-level" [profile="hysteresis", lower=15, inverted=true] } * Remove cronmaker since it doesn't support HTTPS (#1459) 1. When trying to reach https://www.cronmaker.com/ the website refuses the connection. You can only reach it using HTTP (without HTTPS). You could leave cronmaker in there but I think leading users to web pages that aren't using HTTPS might be not be best idea. 2. Fix Typo in url for quartz-scheduler.org * Update links to target "main" branches (#1460) * Update links to target "main" branches Signed-off-by: Wouter Born <github@maindrain.net> * Update process_file.rb Signed-off-by: Wouter Born <github@maindrain.net> * Update for all other repos too Signed-off-by: Wouter Born <github@maindrain.net> * Add hint that /etc/default/openhab2 is not considered by the upgrade (#1461) * Add hint that /etc/default/openhab2 is not considered by the upgrade When you use a raspberry you may have used the file /etc/default/openhab2 to changed JAVA options. After upgrade to openHAB 3.0 this file is no longer used. Instead the file /etc/default/openhab must be used. * Small modifications to original pull request. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Co-authored-by: Jerome Luckenbach <github@luckenba.ch> * Fix typo in restdocs (#1463) * Update rules-dsl.md (#1465) Updated the rule example "Start wake up light on sunrise" to use the new formatting of the receivedEvent implicit variable * Update list of system default channel types (#1467) Related to openhab/openhab-core#2069 Related to openhab/openhab-core#2157 Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de> * Delete habpanel.md (#1471) * Delete habpanel.md This file is gathered from its code repository for a long time already. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Add habpanel placeholder for preview Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Co-authored-by: coop-git <65073745+coop-git@users.noreply.github.com> Co-authored-by: J-N-K <J-N-K@users.noreply.github.com> Co-authored-by: sancho-sumy <59047465+sancho-sumy@users.noreply.github.com> Co-authored-by: Gerwin Lammers <59145105+lampy2@users.noreply.github.com> Co-authored-by: dathbe <github@beffa.us> Co-authored-by: thefechner <76476432+thefechner@users.noreply.github.com> Co-authored-by: Felix Schneider <45742226+Trysupe@users.noreply.github.com> Co-authored-by: Wouter Born <github@maindrain.net> Co-authored-by: BertramVielsack <53342169+BertramVielsack@users.noreply.github.com> Co-authored-by: mueller-ma <mueller-ma@users.noreply.github.com> Co-authored-by: lukiep111 <lukiep@outlook.com> Co-authored-by: Christoph Weitkamp <github@christophweitkamp.de>
openhab · Jan 29, 2021 · a7ef087 · a7ef087
1 parent 2002490
commit a7ef087
Show file tree

Hide file tree

Showing 88 changed files with 1,075 additions and 1,998 deletions.
diff --git a/.github/markdownStyle.rb b/.github/markdownStyle.rb
diff --git a/.github/workflows/brokenLinkCheck.yml b/.github/workflows/brokenLinkCheck.yml
@@ -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
diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml
@@ -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"
diff --git a/.markdownlint.json b/.markdownlint.json
diff --git a/.markdownlint.yaml b/.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
diff --git a/.vuepress/add_placeholders.rb b/.vuepress/add_placeholders.rb
@@ -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

diff --git a/.vuepress/docs-sidebar.js b/.vuepress/docs-sidebar.js
@@ -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'],
     ]
   },
   {

diff --git a/.vuepress/process_file.rb b/.vuepress/process_file.rb
@@ -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 != ""

diff --git a/.vuepress/process_main_docs.rb b/.vuepress/process_main_docs.rb
@@ -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")
 
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.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 <joe.smith@email.com>
+`Signed-off-by: Joe Smith <joe.smith@email.com>`
 
 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 username@users.noreply.github.com) 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.
-
diff --git a/README.md b/README.md
@@ -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>