Commit Graph

1801 Commits (28f15bd68f3ea6c2e204f8db770934e30f14ea52)

Author SHA1 Message Date
dougmcdorman 4a26f9b53a [administration/console.md]Fixing a bug in the Apache Karaf change password command (#611)
This command will remove the comma which makes the new password unusable so it needs put a "," in the replacement string as well.
For comparison look at the password change function which has the "," in both the search and replace.
https://github.com/openhab/openhabian/blob/master/functions/passwords.sh
sed -i "s/openhab = .*,/openhab = $passwordChange,/g" /var/lib/openhab2/etc/users.properties
2018-01-01 21:49:18 +01:00
mod42 d2c3b160be [rules-dsl.md] Changed some typos in the createTimer sample code (#608) 2017-12-30 20:05:36 +01:00
Jason Jones 05b1e854c1 Added triggeringItem to Implicit Variables section
Signed-off-by: Jason Jones <jmsjones@gmail.com>
2017-12-30 14:23:21 +01:00
Brad Gilmer 9ab493436a
[Beginner Tutorial] Addresses #189 - Add pointer to file location info (#603)
* [Beginner Tutorial] Addresses #189 - Add pointer to file location information

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Correct linter errors only.

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* [Address #603] Fix typo in beginner's tutorial
-  Change Paper UI to Basic UI
-  Correct various linter errors

Signed-off-by: Brad Gilmer <brad@gilmer.tv>
2017-12-27 12:50:10 -05:00
Wouter Born 455c19b20b [installation/docker.md]Add required --tty option to Docker documentation (#600)
Signed-off-by: Wouter Born <eclipse@maindrain.net>
2017-12-22 18:25:53 +01:00
Kai Kreuzer d67a7d816d
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-12-22 08:08:32 +01:00
Gabriel Klein 0c1331cbf1 Added some documentation on how to have access to the REST API documentation. (#595)
Signed-off-by: Gabriel Klein <gabriel.klein@nuage.ch> (github: gabrielklein)
2017-12-19 10:08:52 -05:00
Ben Clark 9bbabfce14 Update Linux and Console instructions for 2.2.0 (#588)
* Update Linux instructions for 2.2.0

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

* Correct console link

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

* Add warning about known_hosts file using SSH

And suggest using the Karaf console script instead of SSH on localhost.

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

* Add user/pass info at relevant point.

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

* Update windows with client script note.

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

* Update console page according to reviews

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

* Update Linux page according to reviews

Signed-off-by: Ben Clark <ben@benjyc.uk>
2017-12-16 18:57:32 -05:00
Thomas Dietrich 190bd935f9 Add Home Builder and Android app articles from external repos (#594)
* Add homebuilder to maven chain
* Add android app docs to maven chain
* Correct homebuilder URL
* Introduce maven logging into process script
* Fix linter warnings in update script
* Add first copy of homebuilder article
* Add Home Builder to menu and packages

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-12-16 22:04:24 +01:00
Kai Kreuzer a459e002c1 [configuration/editors.md] removed designer from the editor list and moved network preparations … (#592)
* removed designer from the editor list and moved network preparations to the top as this is relevant for all editors

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* addressed review feedback

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-12-16 15:57:50 +01:00
Kai Kreuzer 1d6d9110c8
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-12-16 12:45:37 +01:00
stephenwb 5e95c37dc4 [introduction.md]Add grammatically-necessary plural ("s") (#584)
The sentence "...to the ability to interact with a large [...] number of physical Thing." needs an "s" on the end of "Thing" to make it correct English.
2017-12-05 22:13:14 +01:00
Mike Kolcun cd63216c95 [configuration/items.md]Fix broken links, remove absolute links (#580)
* fixed broken link

updated broken link to homekit docs

* updated hue link

updated the hue link too

* use base template

replace absolute links to docs.openhab.org with the base template
2017-11-29 15:46:09 +01:00
Thomas Dietrich 25357874cf
Add linkchecker result and badges (#566)
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-29 14:39:38 +01:00
Thomas Dietrich 3c5b40f96e Add ssl-redirect, add to developersguide
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-29 14:26:29 +01:00
Kai Kreuzer f6dbad695e
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-11-27 09:20:24 +01:00
Ian Hubbertz 6437c7d047 [administration/console.md]openhab-distro:#533: Change sshHost description (#504)
* openhab-distro:#533: Change sshHost description

See https://github.com/openhab/openhab-distro/issues/533

However, I only changed this for the *"Bind Console to All Interfaces"* section, but other section are affected by the same issue.

Signed-off-by: Ian Hubbertz ian_web1@hubbertz.de

* Change directory references to $OPENHAB_CONF

-  Addresses comments submitted by @ThomDietrich and @bgilmer77

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Fix long sentence

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-24 00:12:40 +01:00
matushromada b8ea021a3d [installation/windows.md] Missing files to remove (#575)
WIth pull #579 there are two more files to remove during the update: 
userdata\etc\system.properties
userdata\etc\custom.system.properties

Signed-off-by: Matus Hromada matushromada@gmail.com (github: matushromada)
2017-11-23 19:12:00 +01:00
Thomas Dietrich 081d045d07 [Sitemaps] Remove iOS colors warning (#574)
Related to https://github.com/openhab/openhab.ios/pull/131

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-23 17:54:15 +01:00
Jerome L d91a7e9c7c
[rulse-dsl.md]Added trigger channel section (#572)
* Added trigger channel section to rules-dsl.md

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Review based changes

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Adressed last Review comments

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2017-11-22 18:34:22 +01:00
Brad Gilmer fb5e68defa [Introduction] Improve comprehension and tighten up focus (#562)
* [introduction.md] Improve comprehension and tighten up focus of article

- Made numerous changes
- Removed unnecessary material
- Addressed linter errors

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Address comments by @Contrician

Signed-off-by: Brad Bilmer <brad@gilmer.tv> (Github: bgilmer77)

* Add "Getting Started" chapter

- Reorder chapters and put Getting Started at the top
- Add to the OH Community section
- Address comments in PR

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Address remaining comments
-  Corrected bad links

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Change references to article on Concepts to chapters

Signed-off-by: Brad Gilmer <brad@gilmer.tv>
2017-11-21 18:42:33 +01:00
axxelG 6b900fc36a [configuration/persistence.md]Fixed broken link to rules article (#571)
Fixed one broken url to the rules-dsl.md file
2017-11-19 21:04:22 +01:00
Kai Kreuzer 409fdaa5b6 [Editors] Update Designer download information (#568)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-11-16 18:39:10 +01:00
Thomas Dietrich 88ee598640 Move generated content into v folder
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01:00
Thomas Dietrich 4077d8046b Update resulting 2.1.0 pages
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01:00
Thomas Dietrich 52fedb68e7 Add README paragraph on versioning
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01:00
Thomas Dietrich 12746488fa Remove color in versioning button
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01:00
Thomas Dietrich f1ff041c71 Update addons article links
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01:00
Thomas Dietrich 065e9b9324 Update base and root front matter usage
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01:00
Thomas Dietrich 350e14e705 Add modified and compiled 2.1.0 docs version
- _config.yml base change
- _includes/base.html base change
- usermenu change for generated addons urls

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01:00
Thomas Dietrich 26e7b88673 Add version switching button
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01:00
Jerome L 75c6e0b962 Quick fix of the docker run command. (#559)
* Quick fix of the docker run command.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Changed command explanations to list style according to review.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2017-11-14 12:46:12 -07:00
Brad Gilmer 05296f4691
[introduction.md] Improve readability (#560) 2017-11-10 16:43:16 -05:00
Thomas Dietrich 298d664c02 [Security] Fix typo
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-09 00:20:37 +01:00
bgilmer77 2b3586399e [Logging] Add example for logging Item state (#546)
* Add example for logging Item State

-  Addresses #534
-  Edited text to improve comprehension
-  Changed "Demo" to "heating-control.rules" in text
-  Changed "Demo" example to "heating-control.rules" example in #534
-  Article needs more work, but this PR is limited to addressing this issue.

* Address various comments from ThomDietrich

-  Numerous changes to address comments

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Shorten package name/log example

-  Shortened package to e.model.script.heating-control.rules
-  Removed one of the temp entries from the logging example

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Add improvements

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

* Change suggested by @bgilmer

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-08 13:23:08 +01:00
bgilmer77 5532a042e1 [Items] Improve comprehension (#512)
* Improve introductory paragraph

This is a test.
DO NOT approve this PR.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Clarify Item/real world interaction

This is a second test.  I am still learning about GitHub/GitHub Desktop interaction.  The purpose of the test is to check the behavior of GitHub when making multiple commits on a single branch.

I have modified the language to clarify the interaction between Items and the real world through bindings.  While the existing language was okay, I hope this submission provides additional clarity  around the fact that Item states can be set by actions in the real world

* Improve readability of Introduction section

Changed wording in the Introduction section to improve readability and comprehension.

* Correct spelling error and clarify Item/real world interaction

Edited introduction to correct spelling error and clarify Item/real-world interaction.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Item Definition and Syntax: improve readability

Some wording in the Item Definition and Syntax section has been changed to improve readability.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Type: improve readability

Some wording in the Type section has been changed to improve readability

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Name: improve readability

Some wording in the Name section has been changed, and the section has been reorganized to improve comprehension.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Name: Tweak group naming suggestions

Based upon comment from @ThomDetrich, tweak the first scheme for group names.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Label: improve readability

Changed text in the Label section to improve readability and comprehension

* State: improve readability

Made changes to improve readability and comprehension.

* Icons: improve readability

The Icons section has been modified to improve readability and comprehension.

* Group: improve readability

Changes have been made in wording and arrangement to improve readability and comprehension.

* Tags: improve readability

Changes have been made in wording and arrangement to improve readability and comprehension.

* Binding: improve readability

Changes have been made in wording and arrangement to improve readability and comprehension.

* Binding Configuration: improve readability

Changes have been made in wording and arrangement to improve readability and comprehension.
Not sure whether all this 1.x information needs to remain.
Removed information on persistence.  Will look to see if it should be added to other PR on STATE #507.

This complete the nit pass through the items.md file

* Correct linter formatting issues

This commit corrects formatting issues revealed by linter.

* Add some last minute changes

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

* Discuss distinction between command and status

-  End-users may assume that the change in state of a Switch Item reflects the actual state of the Thing.
-  Added section to make clear the difference between command and status
-  May seem obvious, but some implementers could get burned by not thinking this through.

* Add second batch of corrections

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

* Correct typo

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-07 12:37:40 +01:00
Jerome L e92cbee583 [Admin] Add naming convention to bundles (#522)
* Linting update before improving the article.

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Added an article about the bundle naming convention.

Closes #165

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Changes according to the review from @bgilmer77

- Removed the "id" explanation
- Simplified the usage Example

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Edited all code blocks and changed them to "text" instead of "python".

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Review edits.
- Added package namespace
- Changed to a generic description for <prefix>

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Markdown conform list indention

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-06 01:43:26 +01:00
Thomas Dietrich b2ae52ce68
[Sitemaps] Update editors recommendation (#551)
* Fix syntax error and editors change

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

* Fix typo

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-06 01:31:15 +01:00
Jerome L 77afb85cea [Editors] Add LSP to VS Code section (#550)
* Added Marketplace link.\n Corrected image alt tag.\nImproved installation section to marketplace install.\nAdded section about rule validation with a link to the vscode repo readme file.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Added list item 0 in the installation instructions

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Correct list marker

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-06 01:29:36 +01:00
bgilmer77 4a51317763 [Sitemaps] Additional improvements (#542)
* Additional improvements to sitemaps.md

-  Addresses most of @ThomDietrich comments in #528
-  See #528 for open items and questions

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Address numerous comments in #528

-  This commit addresses all but one of @ThomDietrich comments from #528

Signed-off-by:Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Address remaining comments from @ThomDietrich in #542

-  Verified that Slider Items and Setpoint Items do NOT work with Switch Things. Removed text hinting that this was possible.
-  Added back text about visibility working with OR conditions but not with AND conditions

* Remove example from Label and Value Colors section

-  Deleted example and graphic from Label and Value example.  The explanations and the graphic did not match, and contained errors.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Correct error in link in Dynamic Sitemaps section

-  Corrected syntax error in "dynamic icon" link

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Correct link syntax in Dynamic Sitemaps section

-  Corrected link syntax (again)

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
2017-11-05 18:46:18 +01:00
bgilmer77 cd91117882 [Persistence] Add improvements (#535)
* Additional improvements to persistence article

Addressing comments left over from #527
-  Changed that -> than
-  Resolved clashing headlines
-  Strategies section:  added `default` and explained its operation
-  Changed persistence extensions from code block to itemized list

* Improve readability of Strategies and Items sections

-  Reworded some of tne introductory material
-  Reorganized and changed some sub-section titles in Strategies and Items area to improve comprehension.
-  Item Persistence Configuration -> Persistence Configuration
-  Added Persistence Trigers section
-  Strategies section -> Strategies
-  Items section -> Items
-  Addressed comments by @Confectrician

* Address numerous comments from @ThomDietrich

-  Deleted one configuration headline
-  Added intro sentence to configuration section
-  Combined all text about default in one section of the document
-  corrected cronexpression angle bracket error
-  added code fence around everyChange, etc.
-  Removed detail of Quartz stuff and just added a pointer to Rules article
-  Replaced "persist everything" example to persisting Heating_Mode, etc..."
-  Added example of how default works.

* Finishes "nit" pass through Persistence article

-  Numerous small changes to improve readability

* Expand explanation of how one may specify persistence for an Item

-  Existing text was not clear about the syntax one would use with a Persistence Extension in order to specify a persistence store in cases where multiple stores are available.
-  Clarified language and added an example.

* Correct formating of Persistence Extensions

-  Removed extra lines
-  Added code fences

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Format Persistence Extensions as a table

-  Changed Persistence Extensions section from a non-enumerated list to a table
-  Fixed a spelling error in the section on restoring items after a restart

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Fix markdown table style

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-03 18:16:59 +01:00
Jerome L a215d77be9 [Sitemaps] Add MapView, correct mismatching screenshots (#533)
* Updated mismatching Screenshots for the kitchen temperature Item

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Added MapView Sitemap element (includes update of the demo sitemap comment)

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Corrected demo sitemap comment for kichen temperature too.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Changes due to Review from @ThomDietrich.

Generalized Screenshot dimesnions.
Added link to the OSM page.
Corrected Mapview spelling.
Moved Mapview section to another position based on the popularity.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2017-10-30 14:47:58 +01:00
Kai Kreuzer a877f3aaa4
added a round white background to the favicon
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-10-27 17:59:20 +02:00
Christian Häussler 1c3ee27a6c [Docker] Update docker image tag (#544)
Signed-off-by: Christian Häussler <c-n-i@web.de> (github: @cniweb)
2017-10-27 15:11:17 +02:00
Christian Häussler 07c93a827a [Synology] Add logging section (#543)
Signed-off-by: Christian Häussler <c-n-i@web.de> (github: @cniweb)
2017-10-25 23:33:13 +02:00
bgilmer77 4e66f16eb2 [Sitemaps] Improve comprehension (#528)
* Sitemaps: improve comprehension

- made changes to improve comprehension in introduction

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Concepts: improve readability

-  A few minor word changes are recommended
-  Some slight changes to punctuation

* Special Element Sitemap: improve comprehension

- Eliminated redundant statement about sitemapname and filename
- Introduced the term "shall", which indicates that no other choice except the one described is acceptable

* Element Types: improve comprehension

- numerous changes to wording to improve comprehension
-  Addressed PR #523 regarding HLS video element

* Mappings: improve comprehension

-  some changes to improve reader comprehension

* Mapping: Add reference to Items/command-vs-status

- Removed text in mapping article that mentions command vs. status
- Added command vs. status to my PR on items.md
-  Added reference to the items.md section in this document.
This way we have only one place where this point is discussed.

* Color: improve comprehension

-  various changes to increase comprehension

* Address comments received

-  "Renders an Item as a ON/OFF..." changed to "Renders an Item as an ON/OFF..."
-  "Renders an Item in as text changed to "Renders an Item as text".
-  Capitalize Item in two occurances
-  Remove term, "However..."

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
2017-10-24 14:24:42 +02:00
bgilmer77 177101f25d Add and update persistence article (#527)
* Update persistence.md

- updates persistence.md by adding content from old wiki article
- removes references to old wiki article
- addresses #524

* Address comments from @ThomDietrich

-  See GitHub Conversation page for comments addressed.

* Capitalize all instances of "Item"

-  Capitalized all instances of "Item"
-  Did NOT capitalize all instances of "items"

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
2017-10-20 13:35:07 +02:00
Kai Kreuzer f1727cae7b
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-10-18 17:08:32 +02:00
Thomas Dietrich bd3111097b Attend to nit suggestions
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-10-18 17:04:23 +02:00
Thomas Dietrich cb685d4786 Tidy up pom.xml
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-10-18 17:04:23 +02:00