Commit Graph

59 Commits (final-3.0.x)

Author SHA1 Message Date
Yannick Schaus 0965e5ec24 Revert "Clean up the master branch"
This reverts commit bad6b47ef9.

Signed-off-by: Yannick Schaus <habpanel@schaus.net>
2018-06-14 16:43:24 +02:00
Yannick Schaus bad6b47ef9 Clean up the master branch
Signed-off-by: Yannick Schaus <habpanel@schaus.net>
2018-06-14 16:40:05 +02: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
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 90d2886f80 Fix usermenu
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-10-18 17:04:23 +02:00
Thomas Dietrich f0487deb5d Add new externals, rename addons plural
* openHABian USAGE
* alexa-skill USAGE
* mycroft-skill USAGE
* HABPanel config article

persistence -> persistences
io -> ios

Many minor changes to articles

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de>
2017-10-18 17:04:23 +02:00
Thomas Dietrich 826ef4abb4 Distinguish collections, improve update process (#514)
* Rename collection folders

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

* Change all occurences of addons and repos

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

* Add further corrections

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

* Remove temporary directories after processing

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

* Reduce addons menus, show current uncond.

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

* Fix typo

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

* Remove redundant addons from permalinks

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

* Sort UI menu entries correctly

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

* Split maven command

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-09-22 21:05:09 +02:00
Thomas Dietrich e0fc64919d Reduce addons menus, show current uncond.
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-09-21 14:08:35 +02:00
Thomas Dietrich 02fc81714d [WIP] Fix duplicate binding names in user menu (#502)
* Add first menu fix
* Filter legacy and manual bindings from menu

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-09-18 10:15:27 +02:00
Jerome L 0cd2cd15c0 [Configuration] Move Syntax Highlighting page from old wiki (#434)
* Moved Syntax Highlighting page from openhab1-addons wiki into user manual

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

* Cosmetic improvements according to the PR Discussion

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

* Some Improvements from the feedback of @ThomDietrich.
More to come.

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

* General:
Added some introduction sentences.
Updated Notepad++ "installation" section

Eclipse SmartHome Designer:
Moved ESH article from installation category to editors page.
Additionally removed the navigation menu entry and updated all references to other articles and moved used images in the now necessary folder.

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

* Improvement due to requested change
"First letter of a line capital pls"

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

* Requested Name and capital Letter changes.

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

* Updated mcedit section.
Signed-off-by:  Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)

* - Requested changes by ThomDietrich
- Additionally shortenend the "Others" Section

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

* Typo correction and intro text update to current headlines.

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

* - Defined headanchor explicitly
- Added designer.md file with a redirection to the new editors page.
- Removed some sentences of the introduction
- Changed the "Others" headline

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

* Add stable anchors

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-08-27 12:56:55 +02:00
Steve Bate 8ea07acaf6 Add JSR223 subpages to nav menu (#446)
Signed-off-by: Steve Bate <svc-github@stevebate.net> (github: steve-bate)
2017-07-26 17:24:50 +02:00
Steve Bate 7ad0c7ce93 Add initial JSR223 documentation (#428)
Signed-off-by: Steve Bate <svc-github@stevebate.net> (github: steve-bate)
2017-07-14 14:07:51 +02:00
Jerome L a601f8c9e8 Add IoT Marketplace page to sidenav (#427)
* Add IoT Marketplace Page to Side-Nav

Fixes #424

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

* Changed link order

Changed the nav elements order.
This sorts it according to the page content.

Signed-off-by:  Jerome Luckenbach <github@luckenba.ch> (github: Confectrician)
2017-07-06 17:36:19 +02: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
John Cocula 0698bf54d9 [Add-ons] Revise add-ons list handling and menu structure (#332)
* Put content on addons/io.md page

Fixes #330

Also:

* Removed manually maintained submenu contents
* Updated and added icons
* Fixed small bug in actions page

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

* Consolidated duplicated code

* Remove errant build output

* Small cleanup

Signed-off-by: John Cocula john@cocula.com
2017-02-19 12:45:47 +01:00
Thomas Dietrich 6bf2a4287e [Installation] Pine A64 article and openhabian content (#325)
* Add first pine content

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

* Fix review comments

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

* Revert username:password till a decision is made

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

* Update openhabian.md

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

* Update openhabian.md

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

* Update openhabian.md

* Update user-menu.html

* Update index.md

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-02-17 23:59:39 +01:00
John Cocula 63b831e528 [Add-ons] Factor OH1 add-on docs into site (#284)
* Factor OH1 addon docs into site, filter lists by source and install status.  Fixes #280

Signed-off-by: John Cocula <john@cocula.com> (github user: watou)

* Fixed typos.

* Add title to front matter for add-ons readmes that don’t already have front matter.

Also clean up new doc directories.

* Add warning comment in modified readmes

* Don’t remove “Persistence” from “Java Persistence API”

* address comments

Signed-off-by: John Cocula <john@cocula.com>
2017-02-04 20:26:08 +01:00
Ben Clark b474a81d64 [Security] Fix nginx code closures, add TOC (#263)
* Fix nginx code closures in tabbed section

Made them into own categories instead of bolding statements (which was a workaround for when he had <4 headings.

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

* Missed one

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

* Missed another...

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

* Add nginx header anchors

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

* Add TOC for nginx

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

* Rename security menu entry

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-01-31 14:48:00 +01:00
NicoVermeir 19265e8e03 [Apps] Add windows app article (#255)
* Create windows.md

* Add files via upload

* Update windows.md

* Update uis.md

* Update windows.md

* Add Windows app option to user-menu

Signed-off-by: Nico Vermeir <nico_vermeir@hotmail.com> (github: nicovermeir)
2017-01-23 20:17:14 +01:00
Kai Kreuzer 00db391e8b [Console] Replace "Karaf console" by simply "console" (#217)
* Replaced "Karaf console" by simply "console"

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

* also changed menu entry

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

* some missed changes...

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

* moved sentences to single lines

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-01-18 17:50:32 +01:00
Kai Kreuzer dfe07871e8 Replace nginx by security article, add more details (#218)
* replaced nginx by security article, which also covers:
- changing HTTP(S) port
- Jetty SSL certificate
- restriction of network interfaces to use
- options for remote access (VPN, myopenHAB, reverse proxy)

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

* adapted openHABian comment and added newlines

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-01-17 18:31:57 +01:00
Kai Kreuzer c912276f16 [Bindings] Correct sorting in the menu by id (#173)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-01-16 10:49:26 +01:00
Kai Kreuzer ce6be76a90 Small improvements on the menu
- removed rules from 3rd party integration
- changed menu text of myopenhab

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-12-15 15:06:13 +01:00
Thomas Dietrich b0be055134 Update myopenHAB links
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 30973ce2aa Fix Configuration links, add apps
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 73f26ab865 Refactor Add-ons
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 48ec0b2240 Add Initial Setup Packages article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich cde493073d Add REST API article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 1fc06d6950 Add missing Overview links for expansion
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 7a57eb3609 Rearrange user-menu Add-ons
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 11557486b5 Update menu entry names, many small changes
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 757efad899 Add QNAP NAS article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich b4f4e77421 Rearrange menu
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich a5802e3d94 Add further rearrangements and fixes
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 878f3af234 Add my.openhab to Installation&Setup 2016-12-14 19:05:17 +01:00
Thomas Dietrich 11a232140c Update menu structure 2016-12-14 19:05:17 +01:00
Thomas Dietrich 29b9ac1c7c Move articles, adapt menu
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich d710242f3a Replace tabs by spaces, apply auto indent
Done using Atom Editor with default settings (tab length = 2 spaces)
2016-12-03 14:34:20 +01:00
Kai Kreuzer adcd0d774f added some initial documentation about multimedia (audio & voice) features (#137)
* added some initial documentation about multimedia (audio & voice) features

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-11-18 08:29:19 +01:00
Kai Kreuzer 6f06701be9
fixed escaping of quotes and voice service menu
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-11-13 22:46:34 +01:00
Kai Kreuzer a0424deca7 added automatic inclusion of voice add-ons
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-11-12 21:17:52 +01:00
Kai Kreuzer 5a14eef01d
updated generated content and added imperihome integration
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-11-11 09:30:30 +01:00
Ben Clark 7267109083 Address problems with nginx configuration example (#99)
* Address problems with nginx configuration example

Include X-Forwarded Protocol
Disable Proxy buffering by default

* Updated Reverse Proxy page with tutorial

Removed reference to Jetty, replaced file with NGINX

* Added domain independant instructions

Also a short section about getting a domain name.

* Suggested removing HSTS if sticking to HTTP

* Fix typo
2016-09-28 15:04:00 +02:00
Kai Kreuzer d29883e4b9 Updated auto-generated content and added HABmin and HABPanel to the menu
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-09-24 22:45:27 -07:00
Thomas Dietrich 0855a88094 Revert and adapt usermenu
The menu will soon be overhauled. Till then let's keep it as is.
'items.html' was added

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-09-18 15:26:48 +02:00
Paul Hansen c62a8942c0 Add and update wiki items article (#68)
* Draft

Draft docs article for review

* Move items.md

* Revert

* Updated to include Things and Items

Added a link for the Items and Things page.

* Update Basic Concepts

Updated basic concepts as per https://community.openhab.org/t/documenting-openhab-2/10568/28 

Review of the rules and scripting section needs to be made.

* Draft Updates

Updates from discussion with ThomDietrich

* Small revisions

Minor revisions of text and replaced duplicated data with links to
external pages for further information.
2016-09-18 14:23:40 +02:00
Thomas Dietrich c14c0ee42b Update installation Linux and RPi (#73)
user-menu.html the changes are 95% spaces/tabs/formatting/indention fixes.

apt.md was removed because there should be only one article for Linux (besides one for Mac, one for Windows, ...), containing both installation methods and all other related topics. Having one of the methods in an extra file doesn't make sense.

linux.md apt as base, a few things from the rasspi document, many new chapters. Still missing: de/reinstallation, backup, manual->non-root, manual->upgrade, probably more

rasppi.md moved a few chapters to linux.md



Squash commits
Update
Add first half of manual installation instructions
Update linux.md
Update linux.md
Update linux.md
Update linux.md
Update linux.md
Update linux.md
Update linux.md
Update linux.md
Update linux.md
Add notes on apt snapshot installation
Update rasppi and index
Add backup info
Fix small details
2016-08-14 22:50:23 +02:00
Thomas Dietrich 39f5813968 Update installation overview and RPi article (#65)
* Replace Overview article
* Move chapter on service to RPi
2016-08-07 18:55:01 +02:00