Commit Graph

135 Commits (2.5.x)

Author SHA1 Message Date
Hilbrand Bouwkamp ef25fb57cd
[developers] Added Discovery that is bound to a Thing section (#1262)
Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2020-12-19 17:44:54 +01:00
Andrew Fiddian-Green c04237dc5e
[documentation] clarification of representation property (#1248)
* [documentation] clarification of representation property

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] adopt suggestions of reviewers

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] commas

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] addopted suggestions of @bobadair

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentaion] example added back

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentaion] simplified text

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] adopted reviewer comment

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2020-07-09 20:49:51 +02:00
Fabian Wolter 73ed3ba43d
Remove Apache Commons from Default Libraries (#1229)
See openhab/openhab-addons#7722
Signed-off-by: Fabian Wolter <git@fabian-wolter.de>
2020-06-16 22:23:38 +02:00
Wouter Born 033f33f5f3
Fix broken ESH links (#1231)
Signed-off-by: Wouter Born <github@maindrain.net>
2020-06-16 22:06:32 +02:00
Christoph Weitkamp 2783303217
Update thing-xml.md (#1236)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2020-06-16 22:05:30 +02:00
Fabian Wolter 1ea82164ad
Remove unnecessary isCancelled() from code example (#1235)
Cancelling an already canceled task has no effect. IMHO this check is not necesssary and removal would simplify the code. I came to this because I saw this pattern in many bindings during reviewing.

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>
2020-06-16 22:01:28 +02:00
Stefan Zabka b6209fe86a
Make Subheadings Use Proper Subheading Syntax (#1234)
This way they render out as proper markdown and don't look weird on the website

Signed-off-by: Stefan Zabka <zabkaste@informatik.hu-berlin.de>
2020-06-16 22:00:22 +02:00
Fabian Wolter 8a3477c3aa
Add doc folder to the binding directory structure (#1230)
Signed-off-by: Fabian Wolter <github@fabian-wolter.de>
2020-06-16 21:59:28 +02:00
Mark Theiding 76aa4b2f12
Update contributing.md (#1228)
Small refinement on documentation change submission flow. 

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>
2020-06-16 21:56:35 +02:00
Mark Theiding 942580dab1
Update contributing.md (#1227)
Need to escape \< and \> in the sign off message format so users see them explicitly in the Contributing to the Documentation section. 

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>
2020-06-16 21:56:01 +02:00
Mark Theiding e85faf066b
Update eclipse.md (#1226)
Added additional structure around install, run, debug and update steps. Provided more pointers to interactions with Eclipse, Maven and Git.

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>
2020-06-16 21:55:31 +02:00
Mark Theiding 5154f542f1
Update eclipse.md (#1225)
Clarifying that it's no longer possible to make changes in the Core Framework for 2.5.x.

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>
2020-05-17 12:06:35 +02:00
Mark Theiding fadc2d6399
Add section for documentation contributions (#1205)
Hopefully this will lower the hurdle for people to submit documentation contributions. I know from myself that I didn't submit various documentation improvements, because I didn't know git and thought it would be a much more involved process. 
Ideally there would be a separate documentation section, but submitting this under the development contribution page for now (as per discussion with @Confectrician in https://github.com/openhab/openhab-docs/pull/1179#issuecomment-605642091).
Note that I am addressing the issue of DCO failures wrt specifying the full name that I ran into myself in https://github.com/openhab/openhab-docs/pull/1197#issuecomment-615597308. I found a good discussion of the issue at https://github.com/probot/dco/issues/43.

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>
2020-04-28 19:59:51 +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
theiding 5197c33784
Ending an active scan/stopScan (#1179)
Signed-off-by: Mark Theiding <mark.theiding@gmail.com>
2020-03-28 20:35:45 +01:00
theiding 4d28d4ef19
Minor language tweak (#1178) 2020-03-28 19:01:25 +01:00
Skinah 2c3b84a72e
Update index.md (#1170)
Link appears to be wrong and does not work when I click on it in Edge. Loads the same page again instead of loading the correct new page from the hyperlink.

https://www.openhab.org/docs/developer/guidelines.html
2020-03-16 21:20:53 +01:00
cpmeister 9597f3178f
Fix broken link (#1165) 2020-03-01 15:55:58 +01:00
Chris Carman 0e5367e553
Tiny grammar corrections (#1147) 2020-02-01 23:58:11 +01:00
Christoph Weitkamp 743d40c558 Added cross link and annotation in example (#1145)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2020-01-23 12:58:46 +01:00
Hilbrand Bouwkamp 52a8064283 [eclipse] Adapted ide documentation for 2.5.x (#1141)
Updated documentation for 2.5.x development.

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2020-01-20 19:20:59 +01:00
Bob A 36ae1750fd Minor fix to code example (#1137) 2020-01-11 19:30:07 +01:00
Hilbrand Bouwkamp 6ac9f36044 Changed related to rename of openHAB2-addons (#1114)
* Renamed references of openhab2-addons to openhab-addons

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>

* Removed legacy ide description

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>

* Fixed links to installing ide

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2020-01-07 23:38:13 +01:00
tmrobert8 60286f2616 VSCode add to setting (#1124)
* Fix start.sh debug command

Signed-off-by: Tim Roberts <troberts@bigfoot.com>

* Added to VSCode settings

Signed-off-by: Tim Roberts <timmarkroberts@gmail.com>

* Added settings.json and references to it

Signed-off-by: Tim Roberts <timmarkroberts@gmail.com>

* Fix typos

Signed-off-by: Tim Roberts <timmarkroberts@gmail.com>
2020-01-07 22:43:42 +01:00
pravussum c237a7f755 add IntelliJ developer setup HowTo (#1127)
* add IntelliJ developer setup HowTo

Signed-off-by: pravussum <pravussum@users.noreply.github.com>
Signed-off-by: Robert Bach <openhab@mortalsilence.net>

* fixed minor formatting issue

Signed-off-by: pravussum <pravussum@users.noreply.github.com>
Signed-off-by: Robert Bach <openhab@mortalsilence.net>
Signed-off-by: pravussum <pravussum@users.noreply.github.com>

* Apply suggestions from code review

Co-Authored-By: Jerome Luckenbach <github@luckenba.ch>
Signed-off-by: Robert Bach <openhab@mortalsilence.net>

* fixed heading hierarchy

Signed-off-by: Robert Bach <openhab@mortalsilence.net>

Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
2020-01-06 18:17:26 +01:00
Mr_Ronfo 6d13507f02 Fixed a broken anchor to Thing lifecycle paragraph (#1120) 2020-01-03 17:37:18 +01: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
Mr_Ronfo faf4bb1b51 Corrected "adding dependencies" link (#1118)
Previous one was returning http 404
2019-12-27 16:17:10 +01:00
Christoph Weitkamp b714008d16 Added information about i18n of Discovery Results (#1109)
* Added section about "Internationalization of Discovery Services"

- Added section about "Internationalization of Discovery Services"

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Added section about "Discovery Results"

- Added section about "Discovery Results"

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Update developers/utils/i18n.md

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Update developers/utils/i18n.md

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-12-25 19:43:10 +01:00
Christoph Weitkamp e82b539c6f Configuration Admin Service: Added nullness annotations in examples (#1105)
* Added nullness annotations

- Added nullness annotations
- Applied formatter
- Fixed example code

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Improved Hint

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-12-18 22:28:27 +01:00
Miika Jukka 0ec26ea249 Fix link in binding development section (#1106)
Fix link to contributing.html by removing a subfolder.

Signed-off-by: Miika Jukka <miikajukka@gmail.com>
2019-12-18 22:14:38 +01:00
Christoph Weitkamp cececf35a3 Added information about 'ItemStatePredictedEvent' and 'GroupItemStateChangedEvent' (#1100)
- Added information about `ItemStatePredictedEvent` and `GroupItemStateChangedEvent`
- Applied some linter

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-12-16 20:39:50 +01:00
Daniel Weisser 3a001d850b Fix typo (#1099) 2019-12-16 20:31:17 +01:00
Christoph Weitkamp 846cdcc28b Added an example for "Contructor Injection" (#1078)
- Added an example for "Contructor Injection" to reference a service

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-11-18 19:57:10 +01:00
Christoph Weitkamp d708cc7079 Fixed broken link (#1083)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-11-18 19:56:56 +01:00
Hilbrand Bouwkamp 073f4c1524 [developers] Removed unneeded step for new binding (#1082)
Because the eclipse launch pom.xml has changed compilation of the bom file is not required anymore to make it work. So this step can be removed from the documentation.

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2019-11-15 19:56:59 +01:00
Christoph Weitkamp 0498c87e2d Added example for multiple configuration (#1075)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-11-12 22:10:08 +01:00
Christoph Weitkamp 8145798969 Applied code formatter in guideline examples (#1073)
* Applied code formatter in guideline examples

- Applied code formatter in guideline examples
- Updated links (http, Java 8 and OSGi)

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Update guidelines.md

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-11-12 20:35:14 +01:00
Arne Seime 559b54d65e Updated develop docs according to spotless maven code formatting plugin (#1058)
* Updated develop docs according to spotless maven code formatting plugin

Signed-off-by: Arne Seime <arne.seime@gmail.com>

* Updated link to code formatter definitions

Signed-off-by: Arne Seime <arne.seime@gmail.com>

* Updated links to code formatting rules. Reverted header numbering change

Signed-off-by: Arne Seime <arne.seime@gmail.com>
2019-11-11 20:03:05 +01:00
Hilbrand Bouwkamp 1aded5aa32 Added detailed rules on capitalization of labels (#1071)
Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2019-11-06 22:43:56 +01:00
Hilbrand Bouwkamp be0577cd03 [developers] Neutralize gender (#1068)
Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2019-10-29 00:12:16 +01:00
Hilbrand Bouwkamp 2569ae3cf8 [developers] Rewrite of eclipse ide documentation (#1064)
Also-By: Christoph Weitkamp <github@christophweitkamp.de>
Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2019-10-24 20:47:51 +02:00
tk-innoq 8732d478a1 Update events.md (#1063)
* Update events.md

* Update events.md

Fix typo.
2019-10-21 12:41:04 +02:00
Christoph Weitkamp 5b4b99d5d6 Update to OSGi Core / Compendium Release 7 (#1062)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-10-15 20:06:49 +02:00
Hilbrand Bouwkamp 89503ba0de Updated descriptions of directory structure (#1052)
Removed structure from binding page as it's duplicated on the guidelines page.
Updated and improved the description on the guidelines page with the information that was on the bindings page (that information was improved recently).

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2019-10-08 20:26:04 +02:00
Axel Köhler 7cbb1d3359 Add missing flag (#1053)
Signed-off-by: Axel Köhler <axel.koehler@kiwigrid.com>
2019-10-03 14:53:51 +02:00
Hilbrand Bouwkamp c4ceb76b9e Updated developer guidelines on logging (#1051)
Updated to better reflect usage. Copied some documentation back from orginial ESH description.

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2019-10-01 14:27:05 +02:00
Christoph Weitkamp ed73ae45d8 Update events.md (#1049)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-09-29 10:39:35 +02:00
Hilbrand Bouwkamp 54d7590f99 Improved binding directory structure example (#1046)
Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2019-09-12 23:44:02 +02:00
Stewart Cossey 09d1627d39 Corrected some items in the Bindings section. (#1039)
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
2019-09-01 15:34:53 +02:00