Commit Graph

567 Commits (2.3-patch)

Author SHA1 Message Date
Svilen 712825dbdd [Developers] Improve prerequisites section (#407)
Some of the articles are extended.
Coding tasks slightly changed.
Added troubleshooting section for Declarative Services.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2017-06-27 13:53:39 +02:00
Kai Kreuzer 58294b579b
added a few logos
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-22 22:04:31 +02:00
Kai Kreuzer adef4f5fc5
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-22 21:28:05 +02:00
Kai Kreuzer d12aa7ddcd
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-22 21:25:24 +02:00
Kai Kreuzer 9f02ae29fc
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-22 21:11:12 +02:00
Stefan Triller d25eba9003 [Items] Corrected default behavior for group functions (#373)
* Corrected behavior for group functions

Signed-off-by: Stefan Triller <stefan.triller@telekom.de>

* Break down sentences to lines

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-06-21 12:42:00 +02:00
Angelos Fountoulakis 2fa83abacc [Windows] Include service installation instructions (#398)
* Include Windows Service Installation method

Signed-off-by: Angelos Fountoulakis <agf@wired-net.gr> (github: AngelosF)

* Small formatting corrections

Signed-off-by: Angelos Fountoulakis <agf@wired-net.gr> (github: AngelosF)

* More formatting changes...

Signed-off-by: Angelos Fountoulakis <agf@wired-net.gr> (github: AngelosF)

* Images for Windows Installation

Signed-off-by: Angelos Fountoulakis <agf@wired-net.gr> (github: AngelosF)

* 1 more image

Signed-off-by: Angelos Fountoulakis <agf@wired-net.gr> (github: AngelosF)

* More formatting changes (and images)

Signed-off-by: Angelos Fountoulakis <agf@wired-net.gr> (github: AngelosF)

* Change wrapper.log destination

Signed-off-by: Angelos Fountoulakis <agf@wired-net.gr> (github: AngelosF)

* Add more SSH Client options

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Added OPENHAB_* (as in oh2_dir_layout)

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Downloadable Wrapper config file

Unfortunately, the auto generated wrapper.conf is "broken" and we need to make significant changes to it for the installation of the Windows service to work.
(temporarily) We can provide two methods/options to fix this issue: (1) download the attached template and overwrite existing or (2) manually edit existing

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Updated following @ThomDietrich's review

Hopefully it's better now... (it's not perfect.. I know :))

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* FIx formatting issues

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Improve numbered list indention

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* New update

[!] Rephrased installation step 4 for the windows service
[-] Removed the "download wrapper.conf" part
[!] added some empty lines between text and images
[!] changed a bit the wrapper.conf content

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Remove file `installation/openHAB2-wrapper.conf`

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Change Windows Service Log destinations

[!] All log destinations (`openhab.log, event.log & wrapper.log`) set to  `C:\openHAB2\userdata\logs` (instead of `C:\openHAB2\logs`) as specified in the File Locations section

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Added first image (JAVA_HOME.png)

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Changed Image path for Java_Home.png

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Indent SSH instructions

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Add TOC

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-06-19 19:35:02 +02:00
Thomas Dietrich 47e4f3121b [Items] Continue items article revision, #250 (#404)
Continue the items article revision with all comments in #250.
The article is far from perfect. Many things still need to be added and improved.
This PR is another iteration and ready to be merged for now.

Related to #250 #402
Resolves #291
Next look into #373

* Add toc to sitemap article

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Reorganize Items sections

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Update introduction and syntax

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Overhaul Icons section and more

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Add multi binding section

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-06-19 17:55:32 +02:00
Kai Kreuzer 58e83665b4
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-18 23:00:14 +02:00
Ben Clark 7fc10dbb2a [Linux] Enable GPG instructions (#403)
* RPM GPG checking is enabled

Signed-off-by: Ben Clark <ben@benjyc.uk>

* Add repo_gpgcheck

Signed-off-by: Ben Clark <ben@benjyc.uk>
2017-06-17 20:32:51 +02:00
Richard Koshak 40c8a07e0e [Items] Include first article revision (#250)
* Edited Items document:.

* Edited Items document:
Made 'Item' and 'Group' consistently captalized
Minor grammatical and word choice corrections
Clarified the behavior of icons when used with a map
Added the table of contents
Clarified binding/linking to Items.

 Signed-off-by: Richard Koshak rlkoshak@gmail.com (github: rkoshak)

* Reworked the icons section

Added a bullet list of requirements for dynamic icons.
Put the example in a table.
Added more explanation about the filename format
A few more grammatical and word choice changes

Signed-off-by: Richard Koshak <rlkoshak@gmail.com> (github: rkoshak)
2017-06-17 18:05:22 +02:00
Thomas Dietrich fd2512f866
[openHABian] Update article for v1.3
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-06-16 23:01:21 +02:00
Kai Kreuzer ab715c8f7a
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-16 16:50:17 +02:00
lolodomo 8f0ccf5d60 [Sitemaps] Chart element: value "2D" accepted as period (#394)
Mention about not working refresh parameter for chart suppressed as it was fixed recently in Basic UI

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
2017-06-14 12:43:01 +02:00
lolodomo d56799feb4 [Sitemaps] Image element can refer to an Image item (#396)
Fix #395

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
2017-06-14 12:41:24 +02:00
Thomas Dietrich 19d539ca22 Improve backup and restore script
Resolves #176

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-06-13 02:52:36 +02:00
Ben Clark f8c717eafc [Linux] Add instructions for stable RPM packages (#392)
* Added instructions for installing stable RPM packages.

Signed-off-by: Ben Clark <ben@benjyc.uk>

* Official -> Stable

Signed-off-by: Ben Clark <ben@benjyc.uk>
2017-06-10 15:57:41 +02:00
Kai Kreuzer c2b52d3564
added a few logos and regenerated code
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-09 22:40:17 +02:00
Kai Kreuzer 179de7ea04
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-07 13:49:25 +02:00
Alexey Ashurok 6d420ddbea [Synology] Add DS214play to list (#390)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-06-06 20:22:12 +02:00
khior fda4400427 [Synology] Add DS413j to the list of tested devices (#388)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-06-06 20:21:27 +02:00
sihui 61111d0bb4 Add prerequisite to stop openHAB before changing JsonDB files manually (#391)
Changing a JsonDB file manually is only possible if openHAB is stopped first, then perform the changes and then restart openHAB.
See discussion https://community.openhab.org/t/storage-of-items-authored-in-paperui/29427/14

Signed-off-by: Siegfried Huismann sihui@gmx.de (github: sihui62)
2017-06-06 20:19:49 +02:00
Hakan Tandogan 88f065c96d [senseBox] added icon to documentation (#386)
Signed-off-by: Hakan Tandogan <hakan@tandogan.com>
2017-05-24 19:43:22 +02:00
Eamonn O'Connell 751d509cb3 [Android] Add getting started (#381)
* added getting started to android UI

Signed-off-by: Eamonn O'Connell <eamonnoconnell@gmail.com> (github:halfbaked)

* Regarding the android app:
- included additional examples of possible server URLs
- added reference to the remote URL

Signed-off-by: Eamonn O'Connell <eamonnoconnell@gmail.com> (github:halfbaked)

* updated android getting started

* Add small tweaks

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-05-18 15:41:23 +02:00
Ben Clark 56e5d22eb8 [Linux] Change apt instructions to use HTTPS, misc (#385)
- Also fixed markdown not working in collapsible headers.
- Added back the "changing-versions" link.
- Prevented overflowing text on mobile versions in collapsible headers.

Signed-off-by: Ben Clark <ben@benjyc.uk>
2017-05-13 15:48:03 +02:00
Ben Clark 6989d67776 [Linux] Add instructions for RPM based systems (#351)
- Added collapsible includes for easier access.

Signed-off-by: Ben Clark <ben@benjyc.uk>
2017-05-10 15:05:51 +02:00
Eamonn O'Connell f79c8999f9 [Sitemaps] Fix small typo (#380)
Signed-off-by: Eamonn O'Connell <eamonnoconnell@gmail.com> (github: halfbaked)
2017-05-03 16:00:25 +02:00
Thomas Dietrich 9bf45114c7 [Installation] Remove snapshot recommendation (#377)
* Remove snapshot recommendation

* Remove snapshot recommendation from mac article

Resolves #376

Signed-off-by: Thomas Dietrich thomas.dietrich@tu-ilmenau.de (github: ThomDietrich)
2017-05-02 18:59:13 +02:00
Svilen f46be07ea9 Add information about the Static Code Analysis tool (#379)
Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2017-04-26 17:31:19 +02:00
Martin van Wingerden 5487601a75 Update guidelines.md (#374)
The date in the about.html should not always be changed.
2017-04-23 21:18:28 +02:00
Thomas Dietrich a7fd22a985 [Rules] Add a better online generator
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-04-13 14:38:17 +02:00
Eamonn O'Connell 624094ba0c [Rules NG] Update instructions and screenshots (#370)
* Updated Rules Ng document and images to be in sync with current UI, including the
rename from Extensions to Add-ons.

Signed-off-by: Eamonn O'Connell <eamonnoconnell@gmail.com> (github:
halfbaked)

* Improved layout of rules-ng configuration 

Signed-off-by: Eamonn O'Connell <eamonnoconnell@gmail.com> (github:halfbaked)
2017-04-11 11:00:46 +02:00
Kai Kreuzer 752d3dc943
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-03-29 03:24:37 +02:00
ShaunCurrier 943f2a1164 [Console] Update whole Karaf console article (#352)
Resolves #168
Resolves #298 
Resolves #299 
Resolves #345

* Clarify console access via localhost (#168)

Also, minor editing for clarity and ease of use.
Signed-off-by: Shaun Currier <shaun.currier@gmail.com> (github: ShaunCurrier)

* Refresh successful console connection example

Make ssh command ordering more conventional
Signed-off-by: Shaun Currier shaun.currier@gmail.com (github: ShaunCurrier)

* Add detailed console password and port change (#345)

Also reorganized headers to accommodate new detail and for easier navigation.

* Link to bind to all interfaces header

* Add walkthrough for console connection.

Also, clean up wording about distinction of interactive vs. service mode console access.

* Minor cleanups from proofing

* Minor fixes from building and proofing

* Revise whole article

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Update console.md

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-03-18 13:05:00 +01:00
Kai Kreuzer c0efe6050b updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-03-17 19:56:07 +01:00
John Cocula fb194bca9c [Add-ons] Fix #358 (#359)
Resolves #358 

Signed-off-by: John Cocula <john@cocula.com>
2017-03-15 16:19:31 +01:00
Thomas Dietrich 1a8a591d05 [Apps/iOS] Fix myopenhab link, #361 (#362)
Resolves #361 

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-03-15 16:02:52 +01:00
stephenbonar 4eb2a26748 [Things] Add things.md config page (Closes #312) (#321)
* Added content to the Things.md configuration page (Fixes #312)

-Added an introduction section
-Added a things definition section
-Added a discovery based definition subsection
-Added a file based definition subsection
-Added a syntax subsection

Signed-off-by: Stephen Bonar <contactme@stephenbonar.com> (github: stephenbonar)

* Revision of the article

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-03-07 15:44:55 +01:00
John Cocula 917f13ce60 [Add-ons] Add transformation docs (#357)
Signed-off-by: John Cocula <john@cocula.com>
2017-03-02 16:13:47 +01:00
John Cocula 4d420aea18 [Add-ons] Add bindings back to user menu (#356)
This addresses https://github.com/openhab/openhab-docs/pull/355#issuecomment-283513476

Also updated a handful of binding docs resulting from `./update.sh`.

@ThomDietrich, the very long list of Bindings in the menu show their duplicate labels as expected, but one way to improve that is to create a new layout, based on the “documentation” layout, perhaps called “addon”, that shows the metadata on the page (like badges if `install` or `since` metadata given, logo if given, “improve this document” button if `source` given).  Then all you have to do to use the new layout is update `_config.yml` for those collections to which you wish to apply the new layout.

With such a layout, readers’ puzzlement over the duplicate labels would be quickly dispelled.  Would you consider adding a new custom “addon” layout?  Should I?

I don’t think adorning the binding menu items themselves with badges or parenthetical metadata would look good.

Signed-off-by: John Cocula <john@cocula.com>
2017-03-02 11:49:32 +01:00
John Cocula aa2ab2cac1 [Add-ons] Generate as Jekyll Collections instead of Jekyll Pages (#355)
* Generate addon docs as Jekyll Collections instead of Jekyll Pages

Simplifies a lot of Jekyll, makes custom addon layout possible.

Signed-off-by: John Cocula <john@cocula.com>

* Adds-on (all but bindings) in user menu

Signed-off-by: John Cocula <john@cocula.com>

* Added openhab-distro submodule

Signed-off-by: John Cocula <john@cocula.com>
2017-03-02 01:08:44 +01:00
Kai Kreuzer 1d1550d865
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-02-28 10:09:42 +01:00
ShaunCurrier b38a50448d Fix invalid links to IDE and apps docs (#278) (#353)
Signed-off-by: Shaun Currier <shaun.currier@gmail.com> (github: ShaunCurrier)
2017-02-27 20:03:25 +01:00
Hans-Jürgen Hafner be0deb4280 [Synology] Add DS216play as tested device (#346)
Signed-off-by: Hans-Jürgen Hafner <hans-juergen.hafner@t-online.de> (github: hjhafner)
2017-02-26 14:32:38 +01:00
Ben Clark 3adb2d3c42 [Linux] Add instructions for audio privileges (#347)
Also, changed the build list link to the new Artifactory.

Signed-off-by: Ben Clark <ben@benjyc.uk>
2017-02-26 14:29:15 +01:00
Thorsten Rinne 64d85ce029 [Synology] Add DS916+ as tested device (#350)
Signed-off-by: Thorsten Rinne <thorsten@rinne.info> (github: thorsten)
2017-02-26 14:27:55 +01:00
ShaunCurrier fa1db4a1d6 [Sitemap] Fix demo.sitemap link (#348) (#349)
Before fix, link was 404.
Signed-off-by: Shaun Currier <shaun.currier@gmail.com> (github: ShaunCurrier)
2017-02-26 14:26:09 +01:00
Thomas Dietrich 73ed3af5d5 [Linux] Clarify service/systemctl commands (#336)
* Clarify service/systemctl commands

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Rearrange and add (linkable) headline

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-02-22 13:25:19 +01:00
Thomas Dietrich f915f8f287 [Linux] Add Pine64 Z-Wave module port to example (#340)
* [Linux] Add Pine64 Z-Wave module port to example

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-02-20 14:26:14 +01:00
Christian Häussler e0e4d84d4c [Docker] Correct debug parameter (#337)
Signed-off-by: Christian Häussler <c-n-i@web.de> (github: @cniweb)
2017-02-20 11:10:52 +01:00