Fixes for linter errors and markdown configuration. (#1440)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>pull/1441/head
parent
41a4af61b5
commit
f5b9f0a1ee
|
@ -1,5 +1,8 @@
|
||||||
all
|
all
|
||||||
|
|
||||||
|
# Exclude first headline rule to avoid breaking of the introduction page for now
|
||||||
|
exclude_rule 'MD002'
|
||||||
|
|
||||||
# Expect dash usage for unorderd lists
|
# Expect dash usage for unorderd lists
|
||||||
rule 'MD004', :style => :dash
|
rule 'MD004', :style => :dash
|
||||||
|
|
||||||
|
|
|
@ -190,9 +190,7 @@ Alternately, run the following Linux shell command, which will perform the repla
|
||||||
Substitute `1234` with your desired port number.
|
Substitute `1234` with your desired port number.
|
||||||
Depending on your system, you may have to substitute [the directory](#console-settings-files-and-directories) at the end of the command.
|
Depending on your system, you may have to substitute [the directory](#console-settings-files-and-directories) at the end of the command.
|
||||||
|
|
||||||
```shell
|
```sudo sed -i -e "s/sshPort = .*/sshPort = 1234/g" /var/lib/openhab/etc/org.apache.karaf.shell.cfg```
|
||||||
sudo sed -i -e "s/sshPort = .*/sshPort = 1234/g" /var/lib/openhab/etc/org.apache.karaf.shell.cfg
|
|
||||||
```
|
|
||||||
|
|
||||||
## More Information
|
## More Information
|
||||||
|
|
||||||
|
|
|
@ -18,9 +18,7 @@ This article refers to the directory where you installed the distribution as `<D
|
||||||
|
|
||||||
## Build the addons repostory
|
## Build the addons repostory
|
||||||
|
|
||||||
1. fork and clone the [openhab addons repository](https://www.github.com/openhab/openhab-addons) into a new directory (Reference `<ADDON_DIR>` from now on for this arcticle)
|
1. fork and clone the [openhab addons repository](https://www.github.com/openhab/openhab-addons) into a new directory (Reference `<ADDON_DIR>` from now on for this arcticle) with `git clone https://github.com/<yourgitusername>/openhab-addons` (replace git user name accordingly)
|
||||||
|
|
||||||
- Clone with `git clone https://github.com/<yourgitusername>/openhab-addons` (replace git user name accordingly)
|
|
||||||
|
|
||||||
1. open IntelliJ and create a new Project from existing sources (File | New | Project from existing sources) and pick `<ADDON_DIR>`/pom.xml
|
1. open IntelliJ and create a new Project from existing sources (File | New | Project from existing sources) and pick `<ADDON_DIR>`/pom.xml
|
||||||
|
|
||||||
|
|
|
@ -68,8 +68,7 @@ The following steps will show you how to setup a specific bundle for development
|
||||||
|
|
||||||
![define launch.json](./images/ide_setup_vscode_folder_launch.png)
|
![define launch.json](./images/ide_setup_vscode_folder_launch.png)
|
||||||
|
|
||||||
1. Edit launch.json and ...<br>
|
1. Edit launch.json and ...<br>![launch.json changes](./images/ide_setup_vscode_launch.png)
|
||||||
![launch.json changes](./images/ide_setup_vscode_launch.png)
|
|
||||||
|
|
||||||
1. Set the `port` to xxxx (from step 7). This can be skipped if xxxx was 5005 from step 7.
|
1. Set the `port` to xxxx (from step 7). This can be skipped if xxxx was 5005 from step 7.
|
||||||
1. Set the `hostName` to the hostname running openHAB. This can be skipped if running locally (localhost)
|
1. Set the `hostName` to the hostname running openHAB. This can be skipped if running locally (localhost)
|
||||||
|
@ -80,7 +79,6 @@ The following steps will show you how to setup a specific bundle for development
|
||||||
1. Shutdown any instances of openHAB
|
1. Shutdown any instances of openHAB
|
||||||
1. Press `CTRL-SHIFT-P -> Tasks: Run Task -> Start openHAB (Debug)` to start an openHAB instance in debug mode. You should see openHAB startup in a new VSCode terminal.
|
1. Press `CTRL-SHIFT-P -> Tasks: Run Task -> Start openHAB (Debug)` to start an openHAB instance in debug mode. You should see openHAB startup in a new VSCode terminal.
|
||||||
1. Press F5 (or bring up debug in VSCode and choose the "Debug (Attach) - openHAB" configuration) and the following should occur in the VSCode terminal
|
1. Press F5 (or bring up debug in VSCode and choose the "Debug (Attach) - openHAB" configuration) and the following should occur in the VSCode terminal
|
||||||
|
|
||||||
1. The maven compile occuring (successfully)
|
1. The maven compile occuring (successfully)
|
||||||
1. The resulting JAR is copied to the openHAB addons directory (`openhab_addons`)
|
1. The resulting JAR is copied to the openHAB addons directory (`openhab_addons`)
|
||||||
1. Connecting to the openHAB instance (the debug call stack should show a bunch of openHAB type threads running)
|
1. Connecting to the openHAB instance (the debug call stack should show a bunch of openHAB type threads running)
|
||||||
|
|
|
@ -167,13 +167,10 @@ By installing the openHAB process as a service in Windows, you can:
|
||||||
|
|
||||||
1. Your openHAB Windows service is now installed and running.
|
1. Your openHAB Windows service is now installed and running.
|
||||||
|
|
||||||
Validate proper operations by:
|
Validate proper operations by browsing to `http://localhost:8080` and verifying that the Windows Service is running and set to Automatic Startup type.
|
||||||
|
Use `services.msc` and find the `openHAB` service.
|
||||||
|
![Windows Service](images/Windows_Service.jpg)
|
||||||
|
|
||||||
- Browsing to [http://localhost:8080](http://localhost:8080)
|
|
||||||
- Verifying that the Windows Service is running and set to Automatic Startup type.
|
|
||||||
Use `services.msc` and find the `openHAB` service.
|
|
||||||
|
|
||||||
![Windows Service](images/Windows_Service.jpg)
|
|
||||||
- Logging in with an SSH client to the console (see info below)
|
- Logging in with an SSH client to the console (see info below)
|
||||||
|
|
||||||
### File Locations
|
### File Locations
|
||||||
|
|
Loading…
Reference in New Issue