Commit Graph

36 Commits (0b51686ea61a020f892d5855944ff7d538851024)

Author SHA1 Message Date
Claudius Ellsel 3e6882f01e Minimal typo correction and added example in binding development doc (#712)
Signed-off-by: Claudius Ellsel <claudius.ellsel@live.de> (github: claell)
2018-06-11 08:47:18 +02:00
Claudius Ellsel 9cf74fc0b2 Corrected path and typo (#689)
* Corrected path and typo

Signed-off-by: Claudius Ellsel <claudius.ellsel@live.de> (github: claell)
2018-05-27 03:04:18 +02:00
Stefan Triller 9e026457f6 Extraxt null annotations explanation into conventions Section, see ESH (#664)
* Extraxt null annotations explanation into conventions Section, see ESH

Signed-off-by: Stefan Triller <stefan.triller@telekom.de>
2018-04-26 11:07:51 +02:00
Christoph Weitkamp 307f6753fe Updated documentation for creating a binding skeleton (#632)
* Updated documentation for creating a binding skeleton

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

* Added full stop

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

* Added note about license; fixed wrong spellings

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

* Incorporated suggestions from review

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-04-23 09:48:29 -07:00
Stefan Triller a3c1cfe1fd [developers/development/guidelines.md]Sync coding guidelines with ESH (#659)
Signed-off-by: Stefan Triller <stefan.triller@telekom.de>
2018-04-06 22:44:28 +02:00
Martin van Wingerden d060c3e6dc Corrected link to openhab instead of kai's personal repo (#657)
Signed-off-by: Martin van Wingerden <martinvw@mtin.nl> (github: martinvw)
2018-04-05 23:25:14 +02:00
Kai Kreuzer 4d11d9237a [developers/development/guidelines.md] updated coding guidelines (#636)
* updated coding guidelines

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

* added new line per sentence

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

* fixed code fences

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

* fixed "fixed" code fences

One removal was wrong. Now the fences shout fit.

Signed-off-by: Jerome Luckenbach github@luckenba.ch
2018-01-27 19:58:33 +01:00
Svilen 727770bb66 [Development] Add article about OSGi Config Admin (#467)
Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2017-08-30 14:03:11 +02:00
Svilen cef04c01de [Developers] Add article about EventAdmin (#450)
Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2017-07-23 13:55:43 +02:00
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
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
Kai Kreuzer 54a4e7ee6c [Development] Incorporate findings from code reviews (#322)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-02-14 11:44:38 +01:00
Kai Kreuzer d24507340a
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-02-11 20:18:06 +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
Kai Kreuzer a0170564dd Add note regarding service-id in binding.xmls for openHAB 1 bindings (#141)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-11-23 04:34:49 +05:30
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
Svilen 0ee48da5e0 OSGi coding tasks page updated. (#111)
Added names to bundles, where this was missing.
Slightly changed the tasks, after feedback from the first implementations.
Added few hints and links to the Coding Guidelines.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-10-18 12:21:25 +02:00
Kiril Atanasov 4484faa6bd Adding example about.html files to the guidelines (#109)
In the Code Guidelines section, when mentioning the about.html file there could be two examples:
 - about.html file without 3rd party licence information
 - about.html file with 3rd party licence information
It will be easy for the contributers - they will spend less time figuring how the file should look and make fewer mistakes.

There could be a check when a bundle is commited, not only if it contains an about.html file, but also if the about.html file contains one of the dates in the example about.html files. This will help if a contributer has forgotten to change the date in the file.

The example files could be choosen from: https://github.com/openhab/openhab2-addons/pull/1263/files

Signed-off-by: Kiril Atanasov <kiril.atanasov@musala.com>
2016-10-18 12:20:53 +02:00
Svilen 25b21f6386 Added article about logger configuration. (#107)
Topics:

- set-up logging;
- editing the configuration file;
- examples.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-09-30 15:49:36 +02:00
Kai Kreuzer 8049fdd7af fixed broken link (#100) 2016-09-22 15:46:35 -07:00
Svilen e073594df2 Fix several broken links. (#81)
Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-08-22 17:43:17 +02:00
Svilen b35f07882f Fixed broken links. Renamed links, images, files. (#80)
Renamed images with uppercase extensions.
Renamed articles with mixed upper- and lowercase.
Other minor fixes.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-08-20 14:18:52 +02:00
Svilen 8a288d04e4 Added article about target platform. (#79)
Topics:
- what is target platform;
- target definition file;
- Eclipse IDE target platform editor.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-08-17 20:33:37 +02:00
Svilen 011e4e7ca0 Added article about Equinox. (#77)
Topics contained:
- how to start equinox standalone and from Eclipse;
- basic Equinox commands;
- core Equinox bundles and the services, that they provide;
- p2 Equinox subproject - IU and update site.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-08-16 11:51:51 +02:00
Svilen bdb6e3f1d0 Added Tycho article. (#78)
Content:
- integrate plugin with the openHAB Tycho build;
- configure Tycho;
- Tycho dependency resolution problems.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-08-16 11:33:23 +02:00
Svilen a87112ad64 Added article about OSGi Declarative Services. (#76)
The article covers the following topics:
- OSGi DS container, Service Components and Service Description;
- advantages of DS;
- how to use DS to provide and reference services;
- Service Component Lifecycle.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-08-15 20:53:43 +02:00
Svilen 8c659d1c8a Added OSGi coding taks page. (#66)
* Added OSGi coding taks page.

OSGi coding tasks can help Java developers with no experience in OSGi and
Eclipse Plug-in development to get familiar with writing bundles.

Signed-off-by: Svilen Valkanov <svilen.valkanov@musala.com>
2016-08-09 17:40:07 +02:00
Thomas Dietrich 228e74fa83 Add title to most pages, fixes (#60)
minor spelling and format inconsistencies
upper case headlines
deletes spaces and lines at the end

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-08-05 12:10:20 +02:00
Svilen 2504f2018d Added OSGi overview page. (#45)
In the "Deloper Guide" page it was added a new section - "Prerequisites".
New subsection called "OSGi" is created. In the subsection a new pages
is added - "Overview".
The page is aimed to help developers, that are
going to use OSGi for the first time.

Signed-off-by: Svilen Valkanov, svilen.valkanov@musala.com
(github: svilenvul)
2016-07-19 11:19:23 +02:00
Kai Kreuzer 1845c174c2 Revert "Add step to ensure Eclipse "Mars" is selected" (#37) 2016-06-28 14:47:06 +02:00
dmcwhinnie deff94218f Add step to ensure Eclipse "Mars" is selected (#35)
* Add files via upload

* Add step to ensure Mars version is selected instead of Neon.
Can be reverted once this issue is fixed.
https://github.com/eclipse/smarthome/issues/1662
2016-06-25 22:08:02 +02:00
Kai Kreuzer 19709168b9 added archetype build info (#21)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-06-12 11:46:08 +02:00
Kai Kreuzer fc4eb2deb8 reverted _source folder again as it does not seem to be supported by Github Pages
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-05-30 14:50:02 +02:00
Kai Kreuzer 1aa61facd5 introduced _source folder
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-05-30 10:59:32 +02:00
Kai Kreuzer e7d2340092 updated structure
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-05-30 10:30:54 +02:00