OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update menu entry names, many small changes 

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
pull/154/head
Thomas Dietrich 2016-12-06 21:49:56 +01:00 committed by Kai Kreuzer
parent 757efad899
commit 11557486b5
12 changed files with 44 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_includes/contribution-wanted.html
View File

@ -3,10 +3,10 @@
<br />
<div class="row">
<div class="col s10 offset-s1">
<div class="card grey lighten-2">
<div class="card grey lighten-3">
<div class="card-content black-text">
<span class="card-title grey-text">Contributions Wanted</span>
<p>Help improve the openHAB 2.0 documentation! If you'd like to leave fixes, additons or comments for this article, please drop a word at:</p>
<p>Help improve the openHAB 2.0 documentation! If you'd like to leave corrections, additons or comments for this article or any other part of this page, please drop a word at:</p>
</div>
<div class="card-action">
<a href="https://github.com/openhab/openhab-docs/issues">docs.openhab.org Issue Tracker</a>

14
_includes/user-menu.html
View File

@ -5,13 +5,14 @@
<li><a href="{{docu}}/concepts/index.html">Concepts</a>
<ul>
<li><a href="{{docu}}/concepts/index.html">Overview</a></li>
<hr />
<li><a href="{{docu}}/concepts/things.html">Things</a></li>
<li><a href="{{docu}}/concepts/items.html">Items</a></li>
<li><a href="{{docu}}/concepts/discovery.html">Inbox &amp; Discovery</a></li>
<li><a href="{{docu}}/concepts/audio.html">Audio &amp; Voice</a></li>
</ul>
</li>
<li><a href="{{docu}}/installation/index.html">Installation &amp; Setup</a>
<li><a href="{{docu}}/installation/index.html">Installation</a>
<ul>
<li><a href="{{docu}}/installation/index.html">Overview</a></li>
<hr />
@ -27,11 +28,11 @@
<li><a href="{{docu}}/installation/qnap.html">QNAP NAS</a></li>
<hr />
<li><a href="{{docu}}/installation/designer.html">openHAB Designer</a></li>
<li><a href="{{docu}}/installation/nginx.html">Authentication &amp; Encryption</a></li>
<li><a href="{{docu}}/installation/nginx.html">Authentication &amp; HTTPS</a></li>
<li><a href="https://my.openhab.org/docs">my.openHAB (external)</a></li>
</ul>
</li>
<li><a href="{{docu}}/configuration/index.html">Configuration &amp; Usage</a>
<li><a href="{{docu}}/configuration/index.html">Configuration</a>
<ul>
<li><a href="{{docu}}/configuration/index.html">Overview</a></li>
<hr />
@ -52,7 +53,7 @@
<li><a href="{{docu}}/configuration/multimedia.html">Audio &amp; Voice</a></li>
</ul>
</li>
<li><a href="{{docu}}/addons/index.html">Bindings &amp; further Add-ons</a>
<li><a href="{{docu}}/addons/index.html">Add-ons</a>
<ul>
<li><a href="{{docu}}/addons/index.html">Overview</a></li>
<li><a href="{{docu}}/addons/uis.html">User Interfaces</a>
@ -70,11 +71,13 @@
</ul>
</li>
<li><a href="{{docu}}/addons/bindings.html">Bindings</a>
<!--
<ul>
{% for binding in site.data.bindings %}
<li><a href="{{docu}}/addons/bindings/{{ binding.id }}/readme.html">{{ binding.label }}</a></li>
{% endfor %}
</ul>
-->
</li>
<li><a href="{{docu}}/addons/1xaddons.html">1.x Legacy Add-ons</a></li>
<li><a href="{{docu}}/addons/io.html">3rd Party Integration</a>
@ -105,10 +108,9 @@
<li><a href="{{docu}}/administration/jsondb.html">JsonDB Storage</a></li>
</ul>
</li>
<li><a href="{{docu}}/appendix/help.html">Explore the Community</a>
<li><a href="{{docu}}/appendix/help.html">Community Guidance</a>
<ul>
<li><a href="{{docu}}/appendix/help.html">Finding Help &amp; FAQs</a></li>
<li><a href="{{docu}}/appendix/troubleshooting.html">Troubleshooting</a></li>
<li><a href="{{docu}}/appendix/contributing.html">Contributing</a></li>
</ul>
</li>

14
administration/index.md
View File

@ -1,16 +1,14 @@
---
layout: documentation
title: Administration
title: Advanced Functionality and Administrative Tasks
---
{% include base.html %}
# Overview
# Advanced Functionality and Administrative Tasks
As a base technology openHAB uses Karaf. [Apache Karaf](http://karaf.apache.org/) is a modern and polymorphic container able to host different kind of applications.
As a base technology openHAB uses [Apache Karaf](http://karaf.apache.org), a modern and polymorphic container able to host different kinds of applications.
The Karaf Console is a powerful too to interact with the core of your openHAB installation.
Learn more about the advanced administrative capabilities of your openHAB installation in the sub-entries of this menu point.
Therefore some of the administration tasks are performed in the [Karaf console](console.html):
- [Logging](logging.html)
- [Bundle Management](bundles.html)
- [Runtime Commands](runtime.html)
{% include contribution-wanted.html %}

8
appendix/contributing.md
View File

@ -1,5 +1,6 @@
---
layout: documentation
title: Contributing to openHAB
---
{% include base.html %}
@ -12,11 +13,11 @@ Use the table below to determine where your issue should be logged:
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)
Problems and feature requests for openHAB 1 add-ons | [openHAB](https://github.com/openhab/openhab/issues)
Problems and feature requests for openHAB 2 add-ons | [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)
Issues related to Eclipse SmartHome add-ons and core runtime | [Eclipse SmartHome](https://github.com/eclipse/smarthome/issues)
But do not worry - if you are not clear, which category your issue belongs to - we will redirect you, if necessary.
@ -44,4 +45,3 @@ general guidelines for the community as a whole:
respond to an email you are potentially sending to a large number of
people. Please consider this before you update. Also remember that
nobody likes spam.

12
appendix/troubleshooting.md
View File

@ -1,12 +0,0 @@
---
layout: documentation
---
{% include base.html %}
# Troubleshooting Guide
## Add-Ons cannot be installed
Add-Ons to openHAB may be installed from remote repositories. If you miss add-ons or the installation of an add-on is not working most probably you have problems accessing the associated remote repository. In such cases your maven `settings.xml` contains settings that prevent openHAB to access the repository. Try to rename or delete your maven `settings.xml` (located in `~/.m2`) and try again to install your add-on.

3
installation/docker.md
View File

@ -1,5 +1,6 @@
---
layout: documentation
title: Docker
---
{% include base.html %}
@ -56,7 +57,7 @@ then start with ``docker-compose up -d``
**Accessing the console**
```
docker exec -it openhab /openhab/runtime/bin/client
docker exec -it openhab /openhab/runtime/bin/client
```
**Debug Mode**

2
installation/macosx.md
View File

@ -1,5 +1,6 @@
---
layout: documentation
title: Mac OS X
---
{% include base.html %}
@ -100,4 +101,3 @@ openhab>
>
> Safari is supported by openHAB, but the fact is the browser used by the openHAB developer community - and by the owner of the ZWave plugin - is Google Chrome.
> We recommend then Google Chrome, as openHAB 2 is in a beta phase.

1
installation/pine.md
View File

@ -1,5 +1,6 @@
---
layout: documentation
title: PINE A64
---
{% include base.html %}

2
installation/qnap.md
View File

@ -9,3 +9,5 @@ title: QNAP NAS
The [QNAP NAS](https://www.qnap.com) is a NAS server solution for your home, allowing the installation of additional packages.
Download the latest openHAB package for QNAP from [here](https://github.com/openhab/openhab-qnap-qpkg).
{% include contribution-wanted.html %}

2
installation/rasppi.md
View File

@ -24,7 +24,7 @@ Recommended "[headless](https://en.wikipedia.org/wiki/Headless_computer)" hardwa
## Recommended Setup
We are proud to provide a preconfigured image for the Raspberry Pi, with the latest build of openHAB 2.0 and many useful other software components (like Samba, Grafana or Mosquitto) as optional setup steps.
We are proud to provide a preconfigured image for the Raspberry Pi, with the latest build of openHAB 2.0 and many useful software components (like Samba, Grafana or Mosquitto) as optional setup steps.
openHABian is based on Raspbian and under constant improvement.
Check out more details about [openHABian, the hassle-free RPi image](openhabian.html).

22
installation/windows.md
View File

@ -1,26 +1,20 @@
---
layout: documentation
title: Windows
---
{% include base.html %}
# Installation on Windows
## Installing the openHAB runtime
The openHAB runtime comes as a platform-independent zip file.
To install it, follow these simple steps:
To install it, follow these simple steps.
You will need to install Java if not already installed. Go to http://java.com to get it.
Unzip the `openhab-offline-<version>.zip` to where it is intended to be running from, e.g. `C:\openhab`.
Note that there can't be a space in the path, so it can't be in "Program Files" for example.
1. You will need to install Java if not already installed. Go to http://java.com/ to get it.
2. Unzip the `openhab-offline-<version>.zip` to where it is intended to be running from, e.g. `C:\openhab`. Note that there can't be a space in the path, so it can't be in program files in windows.
Start the server: Launch the runtime by executing the script `start.bat`.
Point your browser to `http://localhost:8080` and you should be looking at the openHAB portal page.
## Start the server!
1. Launch the runtime by executing the script `start.bat`
## Go test it!
openHAB comes with a built-in user interface. Point your browser to `http://localhost:8080` and you should be looking at the openHAB startpage.
{% include contribution-wanted.html %}

21
introduction.md
View File

@ -4,11 +4,11 @@ layout: documentation
{% include base.html %}
# What is openHAB
# About openHAB
openHAB is __software__ for integrating different home automation systems and technologies into one single solution that allows over-arching automation rules, and that offers uniform user interfaces.
openHAB is **software** for integrating different home automation systems and technologies into one single solution that allows over-arching automation rules, and that offers uniform user interfaces.
But openHAB is also a __community__ of users, contributors and maintainers.
But openHAB is also a **community** of users, contributors and maintainers.
## openHAB Structure
@ -22,20 +22,17 @@ The structure of openHAB can be summarized this way:
Add-ons can come from three different origins:
* add-ons coming from the Eclipse SmartHome project, as Eclipse SmartHome is the base of openHAB 2,
* add-ons coming from the openHAB version 1 package, as openHAB 2 includes a compatibility layer,
* add-ons made for openHAB 2.
* Add-ons coming from the Eclipse SmartHome project, as Eclipse SmartHome is the base of openHAB 2,
* Add-ons coming from the openHAB version 1 package, as openHAB 2 includes a compatibility layer,
* Add-ons made for openHAB 2.
## The openHAB Community
openHAB is not only a solution but also a community.
The center of this community is the [openHAB forum](https://community.openhab.org).
The center of this community is the [openHAB community forum](https://community.openhab.org).
If you have questions about the use of openHAB, before reporting an issue, or for comments and contributions about the documentation, 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.
Rules about posting an issue and [contributions guidelines](appendix/contributing.html) are in the _Appendix_.
If you have questions about the use of openHAB, before reporting an issue, or for comments and contributions about the documentation, please check the [openHAB community 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.
Rules about posting an issue and [contributions guidelines](appendix/contributing.html) are in the *Appendix*.