Commit Graph

54 Commits (final-2.5.x)

Author SHA1 Message Date
Jerome Luckenbach 74237856b9
Update beginner tutorial (#1182)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2020-12-20 23:55:27 +01:00
Jerome Luckenbach 0b1866d32c
Fixed broken images. (#1247)
* Fixed broken images.

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

* Fix image path

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2020-07-05 15:36:00 +02:00
GumbyMan82 a59523e39b
Revision. (openhab#1187) (#1237)
* Revision. (openhab#1187)

- Update of screenshots, removal of old screenshots
- Chapters for better formatting
- Removal of ZWave chapter (one example of adding things should be enough IMHO)
- Adding items in simple mode and in "manual" mode

Signed-off-by: Sascha Billian <sascha.billian@googlemail.com>

* Use one line per sentence
Signed-off-by: Sascha Billian <sascha.billian@googlemail.com>

Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
2020-07-05 14:52:10 +02:00
josefscript aa165ce4a3
Update configuration.md (#1215)
I'm a beginner myself. Though I liked this tutorial very much, it took me some time trying and erroring and finally reading forum posts to get behind this. I didn't even know there was something like a more modern ping. So maybe others are happy to learn this right from the beginning.
2020-05-17 11:58:22 +02:00
BugSmurF 33d3b8dace
Line 115 broken link - should be: (#1217)
* Line 115 broken link - should be:

({{base}}/docs/configuration/sitemaps.html#element-types)

was:
({{base}}/configuration/configuration/sitemaps.html#element-types)

* Removed diplicated docs breadcrumb

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

Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
2020-05-17 11:56:15 +02:00
Christophe Fergeau f7befb4498
tutorial: Fix description of sitemap 'type' (#1204)
In the tutorial, the generic sitemap description says that ItemType has
to be the same as the type defined in default.items.
Looking at
https://www.openhab.org/docs/configuration/items.html#type and
https://www.openhab.org/docs/configuration/sitemaps.html#element-types
this is incorrect as they take different values.
The example is even mislading as `Switch` is one of the only types which
is common between items and sitemaps. Might be better to describe
`Default` instead.

Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
2020-04-25 10:17:20 +02:00
Bjorn Helgaas 97acebc827
Correct typos (#1190)
* Correct usage of its/it's

"It's" is always a contraction of "it is" or "it has".  "Its" is a
possessive.  Correct a few places where they were used backwards.

Signed-off-by: Bjorn Helgaas <bjorn@helgaas.com>

* Correct "Z-Wave" spelling

Per https://www.z-wave.com/, the canonical spelling appears to be "Z-Wave".
Most places use "Z-Wave" already; change the remaining references to match.

Signed-off-by: Bjorn Helgaas <bjorn@helgaas.com>

* Correct typos and grammatical errors

Correct some typos and grammatical errors.

Signed-off-by: Bjorn Helgaas <bjorn@helgaas.com>
2020-04-11 17:43:39 +02:00
Jerome Luckenbach d4cc7be27e
Introduced many custom containers. (#1117)
* Refactored multiple 'Note:' occurances.

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

* Small fixes

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-12-27 16:18:48 +01:00
Markus Storm 456b53da68 Update migration.md (#1022)
* Update migration.md

added hint to use Karaf console commands to simulate events in rules

* Update migration.md

* Added newlines

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-08-08 20:36:42 +02:00
Richard Koshak 392186ea43 Basic UI Visibility Live Update Works (#1014)
I just tested this and BasicUI visibility does work. The warning should be removed.
2019-07-03 13:40:16 +02:00
Markus Lipp 428452ce7f Fix links (#865)
* Fixed links in uis.md

Multiple dead links fixed

* Fix links

multiple links to addons page fixed

* Delete reference to non-existing doc page

Reorg of docs made the referenced chapter obsolete

* Fixed multiple links

various links fixed

* Fixed links

links to section addons fixed
Deleted reference to yahooweather binding (now obsolete) as example for binding that requires manual thing definition.

* link fixed

link to addons section fixed

* fixed link

fixed link to UI selection screen

* Fix link

Fixed link to addons section

* Fix links, update example

Signed-off-by: Markus Lipp lipp_markus@gmail.com (github: LightIsLife)

Links to addon section and others fixed.
Old example using the now obsolete Yahooweather binding has been replaced with an example using the network binding

* delete link habpanel.md

Deleted inexisitng link

* Fix links index.md

Fixed links

* Fix link sitemaps.md  (code review)

* Update installation/windows.md (Code review)

Co-Authored-By: LightIsLife <lipp.markus@gmail.com>

* Fix typo migration.md (Code review)

* Fixed typo migration.md (code review)

* Update qnap.md
2019-01-15 19:18:58 +01:00
Jollerprutt 271421d469 fix typo (#873) 2019-01-14 21:52:23 +01:00
Yannick Schaus 573a938622 Fix mixed content checks (#874)
Change 2 YouTube images served over HTTP
as detected by the Netlify check.

Signed-off-by: Yannick Schaus <github@schaus.net>
2019-01-14 21:51:22 +01:00
Richard Koshak 248b74cd81 Updating to reflect changes since OH 2 pre release (#776)
* Updating to reflect changes since OH 2 pre release

Adopted the one sentence per line convention used everywhere else in the docs.

Rewrote the paragraph discussing the versions of OH 2 available (Release, Testing, SNAPSHOT). NOTE: the Installation Overview needs to be updated as well. 

Removed discussion of offline and online since I don't think that is correct anymore. There is no mention of different offline/online installs in the installation docs.

Tried to make it more clear that the text based instructions are the recommended.

Replaces 1.9.0 with 1.x.0 and replaced 2.0 with 2.x to make the instructions not specific to the version.

Removed the warnings to create the persistence folder when running in Docker. They are no longer necessary.

In necessary changes for Rules, I removed the "core" from the org.openhab imports as there are some users who might be using script imports as well.

Removed references to ESHD and changed them to reference VSCode instead. Solves #775 

Signed off by Richard Koshak rlkoshak@gmail.com

* Changed to use $OPENHAB_CONF and $OPENHAB_USERDATA

signed off by Richard Koshak <rlkoshak@gmail.com>
2018-10-03 18:55:30 +02:00
Wouter Born 2803603919 Fix configuration file path references (#779)
* Replace 'config/' and 'conf/' with '$OPENHAB_CONF/'

Signed-off-by: Wouter Born <eclipse@maindrain.net>

* Replace ${openhab.home} with $OPENHAB_HOME in compatibilitylayer.md

Signed-off-by: Wouter Born <eclipse@maindrain.net>
2018-10-01 17:19:56 +02:00
Wouter Born 580f30917c Rename all variants to macOS (#778)
Signed-off-by: Wouter Born <eclipse@maindrain.net>
2018-09-18 19:35:39 +02:00
cvdenzen afcbd14efe Paper UI is not new anymore (#763)
In general it is not a good idea to name something new in documentation. To name something old is no problem as old things will only get older.
2018-08-27 08:40:04 +02:00
Skinah 6309c1f5a9 [tutorials/beginner/logs.md] Update logs.md (#716)
* Update logs.md

Signed-off-by: Matthew Skinner nospam@pcmus.com (github: Skinah)

* Update logs.md

Signed-off-by: Matthew Skinner nospam@pcmus.com (github: Skinah)

* Update logs.md

Added newlines as requested.

* Fixed newlines

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-06-12 13:42:52 +02:00
Eiko Wagenknecht 5267a4c3a9 Beginner Tutorial - fix typos and remove wrong reference (#707)
* Beginner Tutorial - fix typos and remove wrong reference

Naming convention is never mentionend

* Update configuration.md

* Update configuration.md

* Update configuration.md

Signed-off-by: Eiko Wagenknecht info@phenx.de (github: eikowagenknecht)

* Update configuration.md

Signed-off-by: Eiko Wagenknecht info@phenx.de (github: eikowagenknecht)
2018-06-09 08:54:17 +02:00
Eiko Wagenknecht ba024ad6a4 Fix typo in beginner tutorial (#706) 2018-06-08 09:11:04 +02:00
Kai Kreuzer cdf481fa5c
fixed spelling 2018-05-21 00:35:57 +02:00
waspie 117ee07353 [tutorials/migration.md] Update migration.md (#630)
* Update migration.md

* Changed to one line per sentence

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-04-26 11:15:13 +02: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
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 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 fbe4718a3b [Tutorials] Add further community example links (#466)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-08-30 14:04:02 +02:00
Isaac I.Y. Saito ab35a42986 Deprecate the old demo page, remove link (#438)
* [demo] Fix non-existent link.

With the old link I get the following browser. I'm not sure the new link in this commit/PR is what is supposed to be:

```
HTTP ERROR 404

Problem accessing /job/openHAB-Distribution/lastSuccessfulBuild/artifact/distributions/openhab-offline/target/openhab-offline-2.0.0-SNAPSHOT.zip. Reason:

    Not Found
```

* Deprecated an old demo page.

* Remove obsolete demo page.

No content was added.
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-07-16 11:39:32 +02:00
Thomas Dietrich df7421d65e Update frameworks and fix highlighting (#417)
* Update materialize, remove material-design-icons

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

* Replace hljs, replace material icons, add rouge style

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-06-29 18:54:19 +02:00
mueller-ma 0dafd55a81 [Migration] Fix typos (#331)
* Changed = to - to fit the layout

* typo

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-02-18 13:05:27 +01:00
macmeck 922bffa324 [Migration] Explain lowercase filenames for icons (#270)
* explain lowercase filenames for icons in migration tutorial and item documentation

* reverted changes in item documentation due to PR #250

* included link to items documentation for further details

* Update migration.md

Accepting contribution under the small patch exception. 
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-02-13 18:39:46 +01:00
Simon Leiner 3cbcc70845 [fixed] small typos in the beginner tutorial (#274)
* [Tutorials] fixed: list is now displayed correctly
* [Tutorials] fixed small typo
2017-01-30 18:10:16 +01:00
Ben Clark 89aec94c3b [Tutorials] Fix some grammatical errors in tutorial index (#265)
* Fixed some grammatical errors in tutorial index

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

* Pesky semicolon...

Signed-off-by: Ben Clark <ben@benjyc.uk>
2017-01-24 17:22:18 +01:00
Thomas Dietrich 4a51dc88ae Restructure Tutorials, Add Community links (#264)
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-01-24 15:08:27 +01:00
Richard Koshak 79c480c49f [Migration] Change Yahoo binding example (#236)
Resolves #233

Updated the Yahoo Weather Binding example to match the one in the README. In particular removing the reference to "unit" (is that supported any longer?), removing the quotes around the woeid in the thing config, and replacing the "#" with ":" in the Item definition.

Signed-off-by: Richard Koshak <rlkoshak@gmail.com> (github: rkoshak)
2017-01-21 23:59:31 +01:00
DocFraggle c8a2ed055a [Tutorial] Add new beginner tutorial, 1st draft (#207)
Transferred from: https://community.openhab.org/t/setting-up-openhab2-from-scratch/20080
Closes #191 

Signed-off-by: Christian Hailer <christian@hailer.eu>
2017-01-20 16:54:01 +01:00
Richard Koshak 2fdfa2c57c [Migration] Change need changes to bullets (#237)
Updated the Needed Changes section to use bullet points.

Reworded to remove extraneous information which is not needed for the explanation (e.g. telling the user where the base classes moved to).

The Preview is not showing the bullet points for the base paragraphs and I'm not where I can test it with Jekyll.

Addresses #183

Signed-off-by: Richard Koshak rlkoshak@gmail.com (github: rkoshak)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-01-20 00:29:53 +01:00
Richard Koshak ce727c022a Delete .migration.md.swp (#235)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-01-19 22:36:56 +01:00
Thomas Dietrich ef3efa803d [Migration] Correct default sitemap explanation (#215)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-01-18 17:46:15 +01:00
Thomas Dietrich cdd9474c93 Replace openHAB 2.0 by openHAB 2
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 36c190a826 Fix style and tag order in tutorials/index.html
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 9aa9853e22 Fix and improve smaller typo and format fus
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich ae502d6f56 Fix migration tutorial link, add html
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Kai Kreuzer 37198647ac Adapt demo and migration tutorial to new package types (#143)
* adapted demo and migration tutorial to new package types

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

* fixed typo

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

* fixed another typo

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-12-03 13:38:27 +01:00
Richard Koshak 8c82a36ec5 Rewrote the Migration Tutorial (#140)
* Rewrote the migration tutorial based on the Migration Tutorial thread on the forum
2016-11-20 08:19:54 +01:00
Ben Clark 26dc4daafd Replace and fix invalid links (#119)
* Replace current broken/absolute links

* Removed accidental duplicate
2016-10-20 15:58:03 +02:00
Brian a75c294a9e Change small details in tutorials/demo.md (#105)
* Small changes: Added one line intro, rewrote/shortened a sentence that was a bit confusing to a beginner like myself, moved a note up to the section of the document to which it referred (although arguably it could have stayed).

* Fixed link to installation prerequisites

* Fixed Link: 404 on Karaf command reference
2016-09-28 00:04:03 +02:00
Kai Kreuzer 815a559936 added explanation of Things (#51)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-08-01 16:59:21 +02:00
Kai Kreuzer 9f7b9833df removed advanced tutorial
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-08-01 14:42:43 +02:00
lolodomo 2d803d719c Remove jar from addons will not uninstall it (#41) 2016-07-13 13:41:48 +02:00
John Cocula 78169e6c8a Corrected configurations and added note about changes to HSBType. (#24)
Signed-off-by: John Cocula <john@cocula.com>
2016-06-13 08:37:47 +02:00