From 280360391931633f6507b8ebd2e7aca50fba3e6b Mon Sep 17 00:00:00 2001
From: Wouter Born <github@maindrain.net>
Date: Mon, 1 Oct 2018 17:19:56 +0200
Subject: [PATCH] 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>
---
 addons/actions.md                            | 2 +-
 addons/index.md                              | 2 +-
 administration/runtime.md                    | 6 +++---
 configuration/addons.md                      | 2 +-
 configuration/eclipseiotmarket.md            | 2 +-
 configuration/multimedia.md                  | 6 +++---
 configuration/packages.md                    | 2 +-
 configuration/rules-dsl.md                   | 2 +-
 configuration/things.md                      | 2 +-
 developers/development/compatibilitylayer.md | 4 ++--
 tutorials/beginner/rules.md                  | 4 ++--
 tutorials/beginner/sitemap.md                | 8 ++++----
 tutorials/migration.md                       | 6 +++---
 13 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/addons/actions.md b/addons/actions.md
index f56294eb7..f95f0c9d4 100644
--- a/addons/actions.md
+++ b/addons/actions.md
@@ -119,7 +119,7 @@ if ((thingStatusInfo != null) && (thingStatusInfo.getStatus().toString() == "ONL
 ### openHAB Subsystem Actions
 openHAB has several subsystems that can be accessed from Rules. These include persistence, see [Persistence Extensions in Scripts and Rules]({{base}}/configuration/persistence.html#persistence-extensions-in-scripts-and-rules), transformations, and scripts.
 
-- `callScript(String scriptName)`: Calls a script which must be located in the config/scripts folder.
+- `callScript(String scriptName)`: Calls a script which must be located in the `$OPENHAB_CONF/scripts` folder.
 
 Scripts are small pieces of Rules DSL code that can be called from Rules. 
 However, Scripts have limitations.
diff --git a/addons/index.md b/addons/index.md
index f5dc50c92..b7d0e95b9 100644
--- a/addons/index.md
+++ b/addons/index.md
@@ -75,7 +75,7 @@ This is because the mqtt Binding is a 1.x add-on.
 The trailing `1` has to be appended for `binding`- and `misc`-addons.
 It is *not needed* for other addon types like `persistence`.
 
-With this information we can now edit the *addons.cfg* file in the `config/services` folder on the machine you are running openHAB on.
+With this information we can now edit the *addons.cfg* file in the `$OPENHAB_CONF/services` folder on the machine you are running openHAB on.
 The path is depending on your installation.
 You can find out the correct locations on the corresponding documentation pages, e.g. [Linux]({{base}}/installation/linux.html#file-locations) or [Windows]({{base}}/installation/windows.html#file-locations).
 
diff --git a/administration/runtime.md b/administration/runtime.md
index 97310b010..e3a84202e 100644
--- a/administration/runtime.md
+++ b/administration/runtime.md
@@ -89,8 +89,8 @@ Usage: smarthome:send <item> <command> - sends a command for an item
 
 | Command | Description |
 |---------|-------------|
-| `smarthome:audio play [<sink>] <filename>` | plays a sound file from the `conf/sounds` folder through the optionally specified audio sink(s)
-| `smarthome:audio play <sink> <filename> <volume>` | plays a sound file from the `conf/sounds` folder through the specified audio sink(s) with the specified volume
+| `smarthome:audio play [<sink>] <filename>` | plays a sound file from the `$OPENHAB_CONF/sounds` folder through the optionally specified audio sink(s)
+| `smarthome:audio play <sink> <filename> <volume>` | plays a sound file from the `$OPENHAB_CONF/sounds` folder through the specified audio sink(s) with the specified volume
 | `smarthome:audio stream [<sink>] <url>` | streams the sound from the url through the optionally specified audio sink(s)
 | `smarthome:audio sources` | lists the audio sources
 | `smarthome:audio sinks` | lists the audio sinks
@@ -107,7 +107,7 @@ Usage: smarthome:send <item> <command> - sends a command for an item
 
 | Command | Description |
 |---------|-------------|
-| `smarthome:> <script to execute>` | Executes a script from the `conf/scripts` folder
+| `smarthome:> <script to execute>` | Executes a script from the `$OPENHAB_CONF/scripts` folder
 
 ### Firmware
 
diff --git a/configuration/addons.md b/configuration/addons.md
index 86b5c6cae..5dd5eaf74 100644
--- a/configuration/addons.md
+++ b/configuration/addons.md
@@ -58,7 +58,7 @@ This is because the mqtt Binding is a 1.x add-on.
 The trailing `1` has to be appended for `binding`- and `misc`-addons.
 It is *not needed* for other addon types like `persistence`.
 
-With this information we can now edit the *addons.cfg* file in the `config/services` folder on the machine you are running openHAB on.
+With this information we can now edit the *addons.cfg* file in the `$OPENHAB_CONF/services` folder on the machine you are running openHAB on.
 The path is depending on your installation.
 You can find out the correct locations on the corresponding documentation pages, e.g. [Linux](/docs/installation/linux.html#file-locations) or [Windows](/docs/installation/windows.html#file-locations).
 
diff --git a/configuration/eclipseiotmarket.md b/configuration/eclipseiotmarket.md
index e04ade9a5..2fee6d28e 100644
--- a/configuration/eclipseiotmarket.md
+++ b/configuration/eclipseiotmarket.md
@@ -36,7 +36,7 @@ This behavior will be changed in future.
 
 The marketplace integration can be configured to only provide add-ons of certain types (Note: Currently only bindings are supported!) and of a certain maturity level.
 
-To do so, you can add a configuration file `conf/services/marketplace.cfg` with content like:
+To do so, you can add a configuration file `$OPENHAB_CONF/services/marketplace.cfg` with content like:
 
 ```conf
 # whether to show bindings from the marketplace (default is true)
diff --git a/configuration/multimedia.md b/configuration/multimedia.md
index ce8b73812..9cda158e8 100644
--- a/configuration/multimedia.md
+++ b/configuration/multimedia.md
@@ -21,7 +21,7 @@ The framework supports some base [functions](https://www.eclipse.org/smarthome/d
 
 ## Audio
 
-openHAB is able to play sound either from the file system (files need to be put in the folder `conf/sounds`), from URLs (e.g. Internet radio streams) or generated by text-to-speech engines (which are available as optional [Voice add-ons](/addons/#voice)).
+openHAB is able to play sound either from the file system (files need to be put in the folder `$OPENHAB_CONF/sounds`), from URLs (e.g. Internet radio streams) or generated by text-to-speech engines (which are available as optional [Voice add-ons](/addons/#voice)).
 
 There are different options for output devices (so called audio sinks):
 
@@ -46,7 +46,7 @@ javasound
 webaudio
 ```
 
-You can define the default audio sink either by textual configuration in `conf/services/runtime.cfg` or in the Paper UI in `Configuration->System->Audio`.
+You can define the default audio sink either by textual configuration in `$OPENHAB_CONF/services/runtime.cfg` or in the Paper UI in `Configuration->System->Audio`.
 
 In order to play a sound, you can use the following command on the console:
 
@@ -99,7 +99,7 @@ mactts:Ioana Ioana (ro_RO)
 mactts:Kanya Kanya (th_TH)
 ```
 
-You can define a default TTS service and a default voice to use either by textual configuration in `conf/services/runtime.cfg` or in the Paper UI in `Configuration->System->Voice`.
+You can define a default TTS service and a default voice to use either by textual configuration in `$OPENHAB_CONF/services/runtime.cfg` or in the Paper UI in `Configuration->System->Voice`.
 
 In order to say a text, you can enter such a command on the console (The default voice and default audio sink will be used):
 
diff --git a/configuration/packages.md b/configuration/packages.md
index a07b73c88..bb9bc8f06 100644
--- a/configuration/packages.md
+++ b/configuration/packages.md
@@ -11,7 +11,7 @@ When starting openHAB for the very first time, you are asked to select an initia
 
 There are four packages to choose from, which will be explained here in detail.
 
-*Note*: If you are doing a headless installation, you can also choose the package by setting the `package` parameter in `conf/services/addons.cfg` (resp. `/etc/openhab2/services/addons.cfg` for apt installations).
+*Note*: If you are doing a headless installation, you can also choose the package by setting the `package` parameter in `$OPENHAB_CONF/services/addons.cfg`.
 
 If you skipped the package installation, the system stays in a minimal setup without any add-ons which also means without any UIs. In such a case, you must configure the add-ons to install in `addons.cfg`.
 
diff --git a/configuration/rules-dsl.md b/configuration/rules-dsl.md
index 92a839e47..34a37d2fb 100644
--- a/configuration/rules-dsl.md
+++ b/configuration/rules-dsl.md
@@ -21,7 +21,7 @@ On this page you will learn how to leverage its functionality to do *real* home
 
 ### File Location
 
-Rules are placed in the folder `${openhab.home}/conf/rules`.
+Rules are placed in the folder `$OPENHAB_CONF/rules`.
 The [demo setup]({{base}}/tutorials/demo.html) already comes with a demo file called `demo.rules`, which has a couple of examples that can be a good starting point.
 
 A rule file can contain multiple rules.
diff --git a/configuration/things.md b/configuration/things.md
index 547bef882..ad9dbe35d 100644
--- a/configuration/things.md
+++ b/configuration/things.md
@@ -62,7 +62,7 @@ See the [configuration tutorial]({{base}}/tutorials/beginner/configuration.html)
 ### Defining Things Using Files
 
 Things can also be defined manually by creating `.things` configuration text files.
-These files are stored in the `things` folder under the openHAB configuration path, e.g. `/etc/openhab2/things/` or `openhab2/conf/things`.
+These files are stored in `$OPENHAB_CONF/things`.
 
 Benefits of defining Things, Items and other aspects of openHAB in configuration text files are, that they are statically defined, unambiguous, flexible and easy to backup and restore.
 The main downsides of configuration files are the effort needed to compose them and the probability for typing errors.
diff --git a/developers/development/compatibilitylayer.md b/developers/development/compatibilitylayer.md
index 54e18d4f4..7ea3638cc 100644
--- a/developers/development/compatibilitylayer.md
+++ b/developers/development/compatibilitylayer.md
@@ -19,8 +19,8 @@ While the openHAB distribution already contains many add-ons of openHAB 1, there
 Test a not included add-on is very straight forward:
  - Start your runtime
  - Install the 1.x compatibility layer by running `feature:install openhab-runtime-compat1x` in the openHAB console
- - As with openHAB 1.x, simply take the jar file of your add-on and place it in the `${openhab.home}/addons` folder.
- - Copy your personal `openhab.cfg` file to `${openhab.home}/conf/services/openhab.cfg`.
+ - As with openHAB 1.x, simply take the jar file of your add-on and place it in the `$OPENHAB_HOME/addons` folder.
+ - Copy your personal `openhab.cfg` file to `$OPENHAB_CONF/services/openhab.cfg`.
 
 ## How to solve problems with a certain add-on?
 
diff --git a/tutorials/beginner/rules.md b/tutorials/beginner/rules.md
index 3022b7224..2ca31876b 100644
--- a/tutorials/beginner/rules.md
+++ b/tutorials/beginner/rules.md
@@ -9,11 +9,11 @@ layout: tutorial-beginner
 Now that we have the two items - "Presence_Mobile_John" aka "Johns mobile" and "Wallplug_FF_LR_TV" aka "TV wallplug LR" - we can create a simple rule.
 Let's assume we want to turn on the wallplug (and give some juice to the connected TV) as soon as John's mobile comes online, turn it off again when the mobile goes offline (this would be a very basic "presence" rule).
 
-Rules are defined in the conf/rules directory.
+Rules are defined in the `$OPENHAB_CONF/rules` directory.
 So we create the file default.rules there.
 
 ```bash
-conf/rules/default.rules
+$OPENHAB_CONF/rules/default.rules
 ```
 
 You can create as many .rules files as you want - this eases the overview of different rules/situations. For example:
diff --git a/tutorials/beginner/sitemap.md b/tutorials/beginner/sitemap.md
index 6ee52867b..a19a3b071 100644
--- a/tutorials/beginner/sitemap.md
+++ b/tutorials/beginner/sitemap.md
@@ -16,8 +16,8 @@ See the linux installation instructions for the [file locations]({{base}}/instal
 macOS files are located in the same place as Linux files.
 
 ```bash
-conf/items    <-- *.items files
-conf/sitemaps <-- *.sitemap files
+$OPENHAB_CONF/items    <-- *.items files
+$OPENHAB_CONF/sitemaps <-- *.sitemap files
 ```
 
 After a fresh installation these directories are empty (except for the readme files), so you have to create a file there. We'll use "default.items" as the items file and "default.sitemap" as the sitemap file in this tutorial.
@@ -28,8 +28,8 @@ After a fresh installation these directories are empty (except for the readme fi
 So we create the files:
 
 ```bash
-conf/items/default.items
-conf/sitemaps/default.sitemap
+$OPENHAB_CONF/items/default.items
+$OPENHAB_CONF/sitemaps/default.sitemap
 ```
 
 Let's start small.
diff --git a/tutorials/migration.md b/tutorials/migration.md
index 93c7d131e..39dd29546 100644
--- a/tutorials/migration.md
+++ b/tutorials/migration.md
@@ -505,7 +505,7 @@ there are no values in the database to restore the Items to when openHAB starts.
 common Sitemap issue will be missing icons. Browse through your sitemap
 methodically and identify those entries that have a missing or wrong
 icon. Select an alternative from the [defaults]({{base}}/addons/iconsets/classic/readme.html)
-or copy the ones you were using from openHAB 1.x to the conf/icons/classic folder. 
+or copy the ones you were using from openHAB 1.x to the `$OPENHAB_CONF/icons/classic` folder. 
 Both BasicUI and ClassicUI pull their icons from that folder. For details on custom icons make
 sure to check the icons section in the [Items]({{base}}/configuration/items.html#icons) documentation.
 One important change since openHAB 1.x is that icon filenames need to be lowercase only in openHAB 2.
@@ -575,7 +575,7 @@ Let's look at a concrete example. The [Yahoo Weather Binding]({{base}}/addons/bi
 supports exactly one Thing which takes two parameters: a WOEID location and unit.
 
 Thus, as described in the Binding's readme one would manually define a Thing in
-a .things file (located in conf/things) with the line:
+a .things file (located in `$OPENHAB_CONF/things`) with the line:
 
 
 ```java
@@ -693,7 +693,7 @@ by identifying those Items that use this binding. On Linux/macOS this can easily
 done with the following command
 
 ```bash
-grep <binding> <openHAB 2 conf>/items/*
+grep <binding> $OPENHAB_CONF/items/*
 ```
 where `<binding>` is the string used in the binding config on the Item. For example: