updated documentation

Signed-off-by: Kai Kreuzer <[email protected]>

CONTRIBUTING.md

@@ -1,19 +1,18 @@
 # Contributing to openHAB
 
-Note that this project is only about building the openHAB distribution (i.e. the ready-to-run binary) - it does NOT contain the source code of all the features of openHAB.
+Before reporting an issue, please check the [openHAB forum] (https://community.openhab.org) for solutions and help. More people will see your issue when it is posted in the forum and community members may be able to help you find known solutions/workarounds for your issue.
 
-These are actually spread over different projects like
-https://github.com/eclipse/smarthome
-https://github.com/openhab/openhab
-https://github.com/openhab/openhab2
-https://github.com/maggu2810/shk
-https://github.com/kaikreuzer/openhab-core
+When no solution was found, use the table below to determine where your issue should be logged:
 
-So please check 
-## Reporting Issues
+Issue | Where to report
+------|----------------
+Problems and feature requests for openHAB 1 addons | [openHAB] (https://github.com/openhab/openhab/issues)
+Problems and feature requests for openHAB 2 addons | [openHAB2] (https://github.com/openhab/openhab2/issues)
+Issues related to the runtime environment, IDE and packaging | [openHAB-distro] (https://github.com/openhab/openhab-distro/issues)
+Issues related to the core openHAB bundles that are not from Eclipse SmartHome | [openHAB-core] (https://github.com/kaikreuzer/openhab-core/issues)
+Issues related to Eclipse SmartHome addons and core runtime | [Eclipse SmartHome] (https://github.com/eclipse/smarthome/issues)
 
-Please report only [openHAB distribution specific issues here](https://github.com/openhab/openhab-distro/issues), while issues that are related to functionality should be reported to the according project.
-Do not worry, if you are not clear, which category your issue belongs to - we will redirect you, if necessary.
+But do not worry - if you are not clear, which category your issue belongs to - we will redirect you, if necessary.
 
 ## Contribution guidelines
 

README.md

@@ -27,6 +27,19 @@ The distribution is available in two flavors:
 
 For the latest snapshot builds, please see to our [cloudbees job](https://openhab.ci.cloudbees.com/job/openHAB-Distribution/).
 
+## Getting Started
+
+If you have downloaded the openHAB distribution zip file, simply unzip it to a local folder and call 'start.sh' (resp. 'start.bat') from the command line.
+The distribution is preconfigured to install demo files, so that you directly have a working instance that you can start playing with.
+
+Once the runtime is started, you can access it in your browser at 'http://localhost:8080/' (note that it might take a bit for the HTTP server to be started, even if the console already welcomes you):
+
+![dashboard](docs/sources/images/dashboard.png)
+
+From here, you can directly access all web-based user interfaces like the new [Paper UI](docs/sources/features/paperui.md) for administration, as well as the [interactive REST API documentation](https://www.eclipse.org/smarthome/rest/index.html). 
+
+For more details on how to get up to speed, please continue reading the [Getting Started page](docs/sources/getting-started.md).
+
 ## Community: How to Get Involved
 
 As any good open source project, openHAB welcomes community participation in the project. Read more in the [how to contribute](CONTRIBUTING.md) guide.
@@ -37,7 +50,8 @@ You can also learn [how openHAB 2 bindings are developed](docs/sources/developme
 
 In case of problems or questions, please join our vibrant [openHAB community](https://community.openhab.org/).
 
-
 ## Trademark Disclaimer
 
 Product names, logos, brands and other trademarks referred to within the openHAB website are the property of their respective trademark holders. These trademark holders are not affiliated with openHAB or our website. They do not sponsor or endorse our materials.
+
+[![Cloudbees](http://www.cloudbees.com/sites/default/files/Button-Built-on-CB-1.png)](https://openhab.ci.cloudbees.com/job/openHAB-Distribution/)

docs/sources/addons.md

@@ -1,6 +1,6 @@
-# List of openHAB 2 Add-ons
+# List of available Add-ons
 
-All optional add-ons for openHAB 2 are [available in a separate download](https://bintray.com/artifact/download/openhab/bin/openhab-2.0.0.alpha2-addons.zip). This file contains all new 2.0 bindings as well as all 1.x add-ons that were reported to be compatible. If you are successfully using a 1.x add-on with the 2.0 runtime, which is not yet on this list, please create a PR for adding it.
+All optional add-ons for openHAB 2 are part of the distribution. This includes all new 2.0 bindings as well as all 1.x add-ons that were reported to be compatible. If you are successfully using a 1.x add-on with the 2.0 runtime, which is not yet on this list, please create a PR for adding it.
 
 ## 2.0 Bindings
 
@@ -14,23 +14,24 @@ All optional add-ons for openHAB 2 are [available in a separate download](https:
 | [HDanywhere Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.hdanywhere/) | HDMI matrix |
 | [IPP Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.ipp/README.md) | Internet Printing Protocol (replaces 1.x CUPS Binding) |
 | [KEBA Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.keba/README.md) | Electric vehicle charging station |
-| [LIFX Binding](https://github.com/eclipse/smarthome/blob/20150525/addons/binding/org.eclipse.smarthome.binding.lifx/README.md) | Wifi-enabled LED bulbs |
+| [FS Internet Radio Binding](https://github.com/eclipse/smarthome/blob/ref-0.8.0.b2/extensions/binding/org.eclipse.smarthome.binding.fsinternetradio/README.md) | Internet radios with chip from Frontier Silicon |
+| [LIFX Binding](https://github.com/eclipse/smarthome/blob/ref-0.8.0.b2/extensions/binding/org.eclipse.smarthome.binding.lifx/README.md) | Wifi-enabled LED bulbs |
 | [Lutron Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.lutron/README.md) | Dimmers And Lighting Controls |
 | [MAX! Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.max/README.md) | Heater control solution by eQ-3 |
 | [Network Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.network/) | Scans local network (replaces 1.x networkhealth Binding) |
-| [NTP Binding](https://github.com/eclipse/smarthome/blob/master/extensions/binding/org.eclipse.smarthome.binding.ntp/README.md) | NTP time servers |
+| [NTP Binding](https://github.com/eclipse/smarthome/blob/ref-0.8.0.b2/extensions/binding/org.eclipse.smarthome.binding.ntp/README.md) | NTP time servers |
 | [PioneerAVR Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.pioneeravr/README.md) | AV receivers by Pioneer |
-| [Philips Hue Binding](https://github.com/eclipse/smarthome/blob/20150525/addons/binding/org.eclipse.smarthome.binding.hue/README.md) | LED lighting system |
+| [Philips Hue Binding](https://github.com/eclipse/smarthome/blob/ref-0.8.0.b2/extensions/binding/org.eclipse.smarthome.binding.hue/README.md) | LED lighting system |
 | [Pulseaudio Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.pulseaudio/README.md) | software-based audio distribution |
 | [Rfxcom Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.rfxcom/README.md) | 433MHz radio transceiver and devices |
 | [SamsungTV Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.samsungtv/README.md) | Samsung Smart TVs |
 | [SMAEnergyMeter Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.smaenergymeter/README.md) | SMA Energy Meter for photovoltaic systems |
-| [Sonos Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.sonos/README.md) | Multi-room audio system |
+| [Sonos Binding](https://github.com/eclipse/smarthome/blob/ref-0.8.0.b2/extensions/binding/org.eclipse.smarthome.binding.sonos/README.md) | Multi-room audio system |
 | [Squeezebox Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.squeezebox/README.md) | Logitech's connected speakers |
 | [Tesla Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.tesla/README.md) | Teslas Model S Electric Vehicle |
 | [Vitotronic Binding](https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.vitotronic/README.md) | Heating systems by Viessmann |
-| [WeMo Binding](https://github.com/eclipse/smarthome/blob/20150525/addons/binding/org.eclipse.smarthome.binding.wemo/README.md) | Switchable sockets by Belkin |
-| [YahooWeather Binding](https://github.com/eclipse/smarthome/blob/20150525/addons/binding/org.eclipse.smarthome.binding.yahooweather/README.md) | Weather information from Yahoo |
+| [WeMo Binding](https://github.com/eclipse/smarthome/blob/ref-0.8.0.b2/extensions/binding/org.eclipse.smarthome.binding.wemo/README.md) | Switchable sockets by Belkin |
+| [YahooWeather Binding](https://github.com/eclipse/smarthome/blob/ref-0.8.0.b2/extensions/binding/org.eclipse.smarthome.binding.yahooweather/README.md) | Weather information from Yahoo |
 
 ## Compatible 1.x Add-ons
 
@@ -101,11 +102,10 @@ All optional add-ons for openHAB 2 are [available in a separate download](https:
 
 | Add-on | Type | Reason
 |--------|------|------|
-| Twitter | Action | [Hardcoded path for local file storage](https://github.com/openhab/openhab/issues/3454)
 
 
 ## Compatible Applications
 
 | Application | Description |
 |-------|----------------------|
-| [iot_bridge](https://github.com/openhab/openhab/wiki/ROS-Robot-Operating-System) | Bridge between ROS Robot Operating System and OpenHAB |
+| [iot_bridge](https://github.com/openhab/openhab/wiki/ROS-Robot-Operating-System) | Bridge between ROS Robot Operating System and openHAB |

docs/sources/development/evolution.md

@@ -1,14 +1,6 @@
 # Technical Difference to openHAB 1
 
-There are a few changes in openHAB 2 that you should be aware of, if you are coming from openHAB 1:
+There are a few technical changes in openHAB 2 that are not compatible with openHAB 1:
 
- - the Classic UI URL has changed from `/openhab.app` to `/classicui/app`, so you can access your sitemaps at `http://<server>:8080/classicui/app?sitemap=<yoursitemap>`
- - a new default sitemap provider is in place, which provides a dynamic sitemap with the name `_default`, which lists all group items that are not contained within any other group.
- - the `configuration` folder has been renamed to `conf`
- - instead of the global `configuration/openhab.cfg` file, there is now an individual file per add-on in `conf/services`
- - The OSGi console commands are now available as "smarthome", not as "openhab" anymore.
  - the REST API does NOT support XML nor JSON-P anymore. It is now fully realized using JSON.
  - the REST API does not support websocket access anymore - it actually completely drops "push" support and only has a simple long-polling implementation to provide a basic backward-compatibility for clients. 
- - The webapps folder has been discontinued, but static resources can be placed in `conf/html`.
- - It is possible to provide your own custom icons in the `conf/icons/classic` folder - no need to overwrite the icons that come with the runtime
- - the rule syntax has slightly changed, you e.g. do not need import statements anymore for the most common classes (see the [Migration Guide](../migration.md) for details). At the same time, there is no openHAB Designer anymore, but the Eclipse SmartHome designer can be used. 

docs/sources/installation/compatibilitylayer.md → docs/sources/features/compatibilitylayer.md

@@ -6,26 +6,23 @@ To still make it possible to use 1.x add-ons, there is a special bundle in openH
 
 Currently, the compatibility layer focuses on the official APIs, i.e. an add-ons that does no dirty things should be able to run. Taking the huge number of 1.x add-ons into account, it is likely that there are a couple of problems with one or another. Some problems might be due to bugs in the compatibility bundle, others might be solvable within the add-on.
 
-In order to find out about the current status of the compatibility, the [compatibility matrix](compatibility.md) can be consulted. Please help filling and updating this matrix (simply edit it using the edit button at the top right).
-
-## How to use openHAB 1.x Add-ons
+## How to use openHAB 1.x Add-ons that are not part of the distribution
 
-This is very straight forward: As with openHAB 1.x, simply take the jar file of your add-on and place it in the `${openhab.home}/addons` folder.
+While the openHAB distribution already contains many add-ons of openHAB 1, there are still quite some of them missing - please help testing them - if they are confirmed to be working, they can be included in the distribution.
+Test a not included add-on is very straight forward: As with openHAB 1.x, simply take the jar file of your add-on and place it in the `${openhab.home}/addons` folder.
 Furthermore, copy your personal `openhab.cfg` file to `${openhab.home}/conf/services/openhab.cfg`.
 Now start up the runtime and touch wood.
 
 ## How to solve problems with a certain add-on?
 
 All developers are encouraged to help on this in order to quickly make as many add-ons compatible with the openHAB 2 runtime as possible.
-Assuming, you have an openHAB 1.x IDE setup with your add-on in the workspace, here is what you need to do:
- - Setup an additional [openHAB 2 IDE](../development/ide.md).
+Here is what you need to do:
+ - Setup a the [openHAB 2 IDE](../development/ide.md).
  - Import your 1.x add-on from your local openHAB 1 git clone into your workspace.
  - If it compiles, the first major step is already done. If not, try to figure out why there are compilation problems and if you cannot solve them, ask on the mailing list for help. 
  - After adding some configuration, start up the runtime through the launch configuration (make sure your bundle is activated and started by default) from within the IDE.
- - Go and test and report your findings by creating issues or pull requests for either the add-on in openHAB 1 or for the compatibility layer in openHAB 2.
+ - Go and test and report your findings by creating issues or pull requests for the add-on in openHAB 1.
 
 ## Future Plans
 
-Our wish is to discontinue the maintenance of the openHAB 1.x runtime and the openHAB 1.x Designer in mid-term. Once the majority of openHAB 1.x add-ons works smoothly on the openHAB 2 runtime, it will be time for this step. Whether there will be a 1.8 or 1.9 runtime will depend on the progress of these efforts.  
-
-Nonetheless, the maintenance and support of the 1.x add-ons will continue much much longer. There is absolutely no need and no rush to port them to the new 2.x APIs - especially as there are only new APIs for bindings so far, but nothing yet for actions, persistence services or other types of add-ons. Even for bindings you have to be aware that the new APIs are not yet stable and are likely to change over time. Nonetheless, if you [start a completely new binding](../development/bindings.md) for openHAB, you are encouraged to go for openHAB 2 directly - especially, if your devices can be discovered and formally described. A positive side effect of implementing a binding against the new APIs is the fact that your code is potentially automatically compatible with other Eclipse-SmartHome-based systems (of which there will be more in future).
+Note that the maintenance and support of the 1.x add-ons will continue. There is absolutely no need and no rush to port them to the new 2.x APIs - especially as there are only new APIs for bindings so far, but nothing yet for actions, persistence services or other types of add-ons. Even for bindings you have to be aware that the new APIs are not yet stable and are likely to change over time. Nonetheless, if you [start a completely new binding](../development/bindings.md) for openHAB, you are encouraged to go for openHAB 2 APIs directly - especially, if your devices can be discovered and formally described. A positive side effect of implementing a binding against the new APIs is the fact that your code is potentially automatically compatible with other Eclipse-SmartHome-based systems (of which there will be more in future).

docs/sources/features/paperui.md

@@ -0,0 +1,19 @@
+# Paper UI
+
+The Paper UI is a new interface that helps setting up and configuring your openHAB instance.
+It does not (yet) cover all aspects, so you still need to resort to textual configuration files, but it already offers the following:
+
+ - Add-on management: Easily install or uninstall openHAB add-ons
+![extensions](images/paperui1.png)
+
+ - Thing discovery: See devices and services found on your network and add them to your setup.
+![discovery](images/paperui2.png)
+
+- Linking items to channels: Instead of adding a binding configuration to your item file, you can directly link Thing channels to your items.
+![links](images/paperui3.png)
+
+Note that you still need to define your items, sitemaps, persistence configurations and rules in the according config files (as done in openHAB 1). Such functionality will be added bit by bit to the Paper UI only.
+
+Here you can find a small screencast about the Paper UI:
+
+[![Paper UI](http://img.youtube.com/vi/MV2a5qwtmRE/0.jpg)](http://www.youtube.com/watch?v=MV2a5qwtmRE)