Merge pull request #185 from ludeeus/documentation

Documentation cleanup
home-assistant · Oct 2, 2018 · c7ca54d · c7ca54d
2 parents c980033 + d34f420
commit c7ca54d
Show file tree

Hide file tree

Showing 18 changed files with 387 additions and 191 deletions.
diff --git a/README.md b/README.md
@@ -1,34 +1,46 @@
-## Hassbian-scripts
-These are the scripts used in the [Hassbian](https://github.com/home-assistant/pi-gen) image.
-The scripts in this repository where made to be used with the Hassbian image and the included Home Assistant instance.  
+# Hassbian-scripts
 
+These are the scripts used in the [Hassbian][hassbian] image.  
+The scripts in this repository where made to be used with the Hassbian image
+and the included Home Assistant instance.  
 
 ## The included scripts
-The following scripts are currently included. You can view the documentation below for usage and instructions.
+
+The following scripts are currently included. You can view the documentation
+below for usage and instructions.
+
 <!--- When adding stuff here, please keep it alphabetical --->
-* [hassbian-config](/docs/hassbian_config.md)
-  * [AppDaemon](/docs/appdaemon.md)
-  * [Cloud9](/docs/cloud9.md)
-  * [Duck DNS](/docs/duckdns.md)
-  * [Hassbian](/docs/hassbian.md)
-  * [Home Assistant](/docs/homeassistant.md)
-  * [HUE](/docs/hue.md)
-  * [LibCEC](/docs/libcec.md)
-  * [MariaDB](/docs/mariadb.md)
-  * [Mosquitto](/docs/mosquitto.md)
-  * [PostgreSQL](/docs/postgresql.md)
-  * [MS SQL](/docs/mssql.md)
-  * [RaZberry ](/docs/razberry.md)
-  * [Samba](/docs/samba.md)
-  * [Trådfri](/docs/tradfri.md)
-  * [Webterminal](/docs/webterminal.md)
-* [Changelog](https://github.com/home-assistant/hassbian-scripts/releases)
+
+- [hassbian-config](/docs/hassbian_config.md)
+  - [AppDaemon](/docs/appdaemon.md)
+  - [Cloud9](/docs/cloud9.md)
+  - [Duck DNS](/docs/duckdns.md)
+  - [Hassbian](/docs/hassbian.md)
+  - [Home Assistant](/docs/homeassistant.md)
+  - [HUE](/docs/hue.md)
+  - [LibCEC](/docs/libcec.md)
+  - [MariaDB](/docs/mariadb.md)
+  - [Mosquitto](/docs/mosquitto.md)
+  - [PostgreSQL](/docs/postgresql.md)
+  - [MS SQL](/docs/mssql.md)
+  - [RaZberry](/docs/razberry.md)
+  - [Samba](/docs/samba.md)
+  - [Trådfri](/docs/tradfri.md)
+  - [Webterminal](/docs/webterminal.md)
+- [Changelog][changelog]
 
 ***
+
 ## Raspbian Jessie
-If this package is used with a Debian Jessie based distribution then you need to uncomment the source repositories in  `/etc/apt/sources.list`
+
+If this package is used with a Debian Jessie based distribution then you need
+to uncomment the source repositories in  `/etc/apt/sources.list`
 
 ```text
 # Uncomment line below then 'apt-get update' to enable 'apt-get source'
 deb-src http://archive.raspbian.org/raspbian/ jessie main contrib non-free rpi
 ```
+
+<!--- Links --->
+[changelog]: https://github.com/home-assistant/hassbian-scripts/releases
+[hassbian]: https://github.com/home-assistant/pi-gen
diff --git a/docs/appdaemon.md b/docs/appdaemon.md
@@ -1,18 +1,22 @@
-## Description
-This Installs AppDaemon in a separate Venv onto this system.\
-For more information about AppDaemon see the [documentation.](http://appdaemon.readthedocs.io/en/latest/)
+# AppDaemon
+
+This Installs AppDaemon in a separate Venv onto this system.  
+For more information about AppDaemon see the [documentation.][appdaemon-docs]
 
 ## Installation
+
 ```bash
-$ sudo hassbian-config install appdaemon
+sudo hassbian-config install appdaemon
 ```
 
 ## Upgrade
+
 ```bash
-$ sudo hassbian-config upgrade appdaemon
+sudo hassbian-config upgrade appdaemon
 ```
 
 ## Additional info
+
 Description | Command/value
 :--- | :---
 Running as: | homeassistant
@@ -21,20 +25,29 @@ Start service: | `sudo systemctl start appdaemon@homeassistant.service`
 Stop service: | `sudo systemctl stop appdaemon@homeassistant.service`
 Restart service: | `sudo systemctl restart appdaemon@homeassistant.service`
 Service status: | `sudo systemctl status appdaemon@homeassistant.service`
-|
 
 Enter the virtual environment where AppDaemon is installed as `homeassistant`:
+
 ```bash
-$ sudo su -s /bin/bash homeassistant
-$ source /srv/appdaemon/bin/activate
+sudo su -s /bin/bash homeassistant
+source /srv/appdaemon/bin/activate
 ```
+
 When you are done, type `exit` to return to the `pi` user.
 
-To manually start AppDaemon, enter the AppDaemon virtual environment as described above, and then type this to start it:
+To manually start AppDaemon, enter the AppDaemon virtual environment as
+described above, and then type this to start it:
+
 ```bash
-$ appdaemon -c /home/homeassistant/appdaemon/
+appdaemon -c /home/homeassistant/appdaemon/
 ```
 
 ***
-The installation script was originally contributed by [@Landrash](https://github.com/landrash).  
-The upgrade script was originally contributed by [@Ludeeus](https://github.com/ludeeus).
+
+The installation script was originally contributed by [@Landrash][landrash].  
+The upgrade script was originally contributed by [@Ludeeus][ludeeus].
+
+<!--- Links --->
+[appdaemon-docs]: http://appdaemon.readthedocs.io/en/latest/
+[landrash]: https://github.com/landrash
+[ludeeus]: https://github.com/ludeeus
diff --git a/docs/cloud9.md b/docs/cloud9.md
@@ -1,24 +1,28 @@
-## Description
-Cloud9 SDK is an webservice IDE that makes it easy to manage your configuration files.
+# Cloud9
 
-*This suite can't be installed on Raspberry Pi Zero*
+Cloud9 SDK is an webservice IDE that makes it easy to manage your configuration files.  
+**This suite can't be installed on Raspberry Pi Zero**
 
 ## Installation
+
 ```bash
-$ sudo hassbian-config install cloud9
+sudo hassbian-config install cloud9
 ```
 
 ## Upgrade
+
 ```bash
-$ sudo hassbian-config upgrade cloud9
+sudo hassbian-config upgrade cloud9
 ```
 
 ## Remove
+
 ```bash
-$ sudo hassbian-config remove cloud9
+sudo hassbian-config remove cloud9
 ```
 
 ## Additional info
+
 Description | Command/value
 :--- | :---
 Running as: | homeassistant
@@ -28,7 +32,10 @@ Start service: | `sudo systemctl start cloud9@homeassistant.service`
 Stop service: | `sudo systemctl stop cloud9@homeassistant.service`
 Restart service: | `sudo systemctl restart cloud9@homeassistant.service`
 Service status: | `sudo systemctl status cloud9@homeassistant.service`
-|
 
 ***
-This script was originally contributed by [@Ludeeus](https://github.com/ludeeus).
+
+This script was originally contributed by [@Ludeeus][ludeeus].
+
+<!--- Links --->
+[ludeeus]: https://github.com/ludeeus
diff --git a/docs/duckdns.md b/docs/duckdns.md
@@ -1,10 +1,15 @@
-## Description
-This script adds an cron job to auto update you the WAN IP address for the defined domain.\
-Before running this script you should already have an Duck DNS account, during the installation you will be asked to supply your domain name and the token for your account.
+# Duck DNS
+
+This script adds an cron job to auto update you the WAN IP address for the
+defined domain.  
+Before running this script you should already have an
+[Duck DNS account][duckdns], during the installation you will be asked to
+supply your domain name and the token for your account.
 
 ## Installation
-```
-$ sudo hassbian-config install duckdns
+
+```bash
+sudo hassbian-config install duckdns
 ```
 
 # Remove
@@ -13,14 +18,22 @@ sudo hassbian-config remove duckdns
 ```
 
 ## Additional info
+
 Running as: `homeassistant`  
 
-If you choose to also generate SSL certificates with this you would need to add this under `http:` to your `configuration.yaml`
-```
+If you choose to also generate SSL certificates with this you would need to
+add this under `http:` to your `configuration.yaml`
+
+```yaml
   ssl_certificate: /home/homeassistant/dehydrated/certs/YOURDOMAIN.duckdns.org/fullchain.pem
   ssl_key: /home/homeassistant/dehydrated/certs/YOURDOMAIN.duckdns.org/privkey.pem
   base_url: YOURDOMAIN.duckdns.org:PORTNUMBER
 ```
 
 ***
-This script was originally contributed by [@Ludeeus](https://github.com/ludeeus).
+
+This script was originally contributed by [@Ludeeus][ludeeus].
+
+<!--- Links --->
+[duckdns]: http://www.duckdns.org
+[ludeeus]: https://github.com/ludeeus
diff --git a/docs/hassbian.md b/docs/hassbian.md
@@ -1,19 +1,25 @@
-## Description
+# Hassbian
+
 This script will update the base OS on the system.
 
 ## Upgrade
-```
-$ sudo hassbian-config upgrade hassbian
+
+```bash
+sudo hassbian-config upgrade hassbian
 ```
 
 ## Additional info
+
 Description | Command/value
 :--- | :---
 Running as: | pi
 Default password: | raspberry
 Hostname: | hassbian
 SSH enabled: | true
-|
 
 ***
-This script was originally contributed by [@Landrash](https://github.com/Landrash).
+
+The installation script was originally contributed by [@Landrash][landrash].  
+
+<!--- Links --->
+[landrash]: https://github.com/landrash
diff --git a/docs/hassbian_config.md b/docs/hassbian_config.md
@@ -1,13 +1,20 @@
-## Description
-This command is a package handler for the Hassbian scripts. All interactions for installing software should be handled through this command.\
-_Running the individual scripts to install software will no longer work as expected._
+# hassbian-config
+
+This command is a package handler for the Hassbian scripts.
+All interactions for installing software should be handled
+through this command.  
+_Running the individual scripts to install
+software will no longer work as expected._
+
+## Usage
 
-#### Usage
 The hassbian-config command is invoked with:
+
 ```bash
 hassbian-config *command* *suite* *flag(optional)*
 ```
-where command is one of:
+
+where `*command*` is one of:
 Command | Description
 :--- | :---
 `install` | Use this to install an suite.
@@ -16,39 +23,43 @@ Command | Description
 `log` | This will show you the log of last hassbian-config operation.
 `share-log` | This will generate an hastebin link of the last hassbian-config operation.
 `show-installed` | Generates a list of installed suites.
-|
 
-Optional flags:
+**Optional flags:**
 Flag | Alt. flag | Description
 :--- | :--- | :---
 `--accept` | `-Y` | This will accept defaults on scripts that allow this.
 `--force` | `-F` | This will force run an script. This is useful if you need to reinstall a package.
 `--debug` | `-D` | This will output every comand to the console.
 `--beta` |`-B` |  This will install the current beta version if implemented.
 `--dev` | | This will install the current development version if implemented.
-|
 
-Other available commands:
+**Other available commands:**
 Command | Alt. command | Description
 :--- | :--- | :---
 `--version` | - `-V` | This will show you the installed version of `hassbian-config`.
 `--help` | - `-H` | Shows help for the tool, with all available commands.
 
 ## Installation
-This package is pre-installed on the [Hassbian image](https://github.com/home-assistant/pi-gen/releases).\
-This package can be used with Raspbian lite but it's not recommended.
-```
-$ curl https://api.github.com/repos/home-assistant/hassbian-scripts/releases/latest | grep "browser_download_url.*deb" | cut -d : -f 2,3 | tr -d \" | wget -qi -
-$ sudo apt install -y ./hassbian*
-```
 
+This package is pre-installed on the [Hassbian image][hassbian-image].  
+This package *can* be used with Raspbian lite but it's not recommended.
 
-## Upgrade
+```bash
+curl https://api.github.com/repos/home-assistant/hassbian-scripts/releases/latest | grep "browser_download_url.*deb" | cut -d : -f 2,3 | tr -d \" | wget -qi -
+sudo apt install -y ./hassbian*
 ```
-$ sudo hassbian-config upgrade hassbian-script
+
+## Upgrade
+
+```bash
+sudo hassbian-config upgrade hassbian-script
 ```
 
 ## Upgrade to dev branch
+
+```bash
+sudo hassbian-config upgrade hassbian-script --dev
 ```
-$ sudo hassbian-config upgrade hassbian-script --dev
-```
+
+<!--- Links --->
+[hassbian-image]: https://github.com/home-assistant/pi-gen/releases
diff --git a/docs/homeassistant.md b/docs/homeassistant.md
@@ -1,6 +1,7 @@
-## Description
+# Home Assistant
 
-This is a copy of the installation script run during first boot of your Raspberry Pi with the [Hassbian image](https://github.com/home-assistant/pi-gen/releases/latest)\
+This is a copy of the installation script run during first
+boot of your Raspberry Pi with the [Hassbian image][hassbian-image]  
 And an easy way to upgrade Home Assistant to the newest version.
 
 ## Installation
@@ -36,6 +37,7 @@ sudo hassbian-config upgrade homeassistant=0.65.6
 ```
 
 ## Additional info
+
 Description | Command/value
 :--- | :---
 Running as: | homeassistant
@@ -75,5 +77,11 @@ hacheckconf | `source /srv/homeassistant/bin/activate;hass --script check_config
 hapyshell | `source /srv/homeassistant/bin/activate;cd ~/.homeassistant`
 
 ***
-The installation script was originally contributed by [@Landrash](https://github.com/landrash).  
-The upgrade scripts was originally contributed by [@Ludeeus](https://github.com/ludeeus).
+
+The installation script was originally contributed by [@Landrash][landrash].  
+The upgrade script was originally contributed by [@Ludeeus][ludeeus].
+
+<!--- Links --->
+[hassbian-image]: https://github.com/home-assistant/pi-gen/releases/latest
+[landrash]: https://github.com/landrash
+[ludeeus]: https://github.com/ludeeus
diff --git a/docs/hue.md b/docs/hue.md
@@ -1,10 +1,17 @@
-## Description
-Configures the Python executable to allow usage of low numbered port numbers for use with Amazon Echo, Google Home and Mycroft.ai.
+# Hue
+
+Configures the Python executable to allow usage of low numbered port numbers
+for use with Amazon Echo, Google Home and Mycroft.ai.
 
 ## Installation
-```
-$ sudo hassbian-config install hue
+
+```bash
+sudo hassbian-config install hue
 ```
 
 ***
-This script was originally contributed by [@Landrash](https://github.com/Landrash).
+
+The installation script was originally contributed by [@Landrash][landrash].
+
+<!--- Links --->
+[landrash]: https://github.com/landrash