From 7e9f3dff56af4ea185907eaa971b5ff3802d0c92 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 2 Jul 2019 19:48:16 +0200 Subject: [PATCH] :pencil2: Fix urls and markdown rules (#9758) --- .../hassbian/common-tasks.markdown | 7 ++- .../hassbian/customization.markdown | 54 ++++++++++--------- .../hassbian/integrations.markdown | 18 +++---- .../installation/hassbian/upgrading.markdown | 1 + 4 files changed, 45 insertions(+), 35 deletions(-) diff --git a/source/_docs/installation/hassbian/common-tasks.markdown b/source/_docs/installation/hassbian/common-tasks.markdown index 3a0894c6c37..765552e5322 100644 --- a/source/_docs/installation/hassbian/common-tasks.markdown +++ b/source/_docs/installation/hassbian/common-tasks.markdown @@ -11,6 +11,7 @@ redirect_from: /docs/hassbian/common-tasks/ --- ### {% linkable_title Login to the Raspberry Pi %} + To login to your Raspberry Pi running Hassbian you're going to be using a ssh client. Depending on your platform there are several alternatives for doing this. Linux and Mac OS generally have a ssh client installed. Windows users are recommended to download and install the ssh client [Putty][ssh-putty]. Connect to the Raspberry Pi over ssh. Default user name is `pi` and password is `raspberry`. @@ -25,6 +26,7 @@ Windows users start [Putty][ssh-putty], enter the IP address of the Raspberry Pi Optionally, starting with Windows 10 anniversary update, you can use the built-in '[Bash on Windows][bash-windows]' to use SSH if you have enabled Developer mode and have installed the "Windows Subsystem for Linux (beta)" feature. ### {% linkable_title Start/Stop/Restart Home Assistant %} + Log in as the `pi` account and execute the following commands: ```bash @@ -61,6 +63,7 @@ This will in order do the following: - Start the Home Assistant service. ### {% linkable_title Manually launch Home Assistant %} + Log in as the `pi` account and execute the following commands: ```bash @@ -72,6 +75,7 @@ $ hass This will start Home Assistant in your shell and output anything that ends up in the log and more into the console. This will fail if the Home Assistant service is already running so don't forget to [stop][stop-homeassistant] it first. If you want the log output to be colored, execute `hass --script check_config` first. This will install the `colorlog` module. ### {% linkable_title Check your configuration %} + Log in as the `pi` account and execute the following commands: ```bash @@ -83,6 +87,7 @@ $ hass --script check_config This will output any errors in your configuration files to console. ### {% linkable_title Read the Home Assistant log file %} + Log in as the `pi` account and execute the following commands: ```bash @@ -130,5 +135,5 @@ $ sudo raspi-config [configuring-homeassistant]: /getting-started/configuration/ [ssh-putty]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html -[stop-homeassistant]: /getting-started/installation-raspberry-pi-image/#startstoprestart-home-assistant-on-hassbian +[stop-homeassistant]: /docs/installation/hassbian/common-tasks/#startstoprestart-home-assistant [bash-windows]: https://msdn.microsoft.com/en-us/commandline/wsl/about diff --git a/source/_docs/installation/hassbian/customization.markdown b/source/_docs/installation/hassbian/customization.markdown index c14491b9502..b20b925fd12 100644 --- a/source/_docs/installation/hassbian/customization.markdown +++ b/source/_docs/installation/hassbian/customization.markdown @@ -13,33 +13,37 @@ redirect_from: /docs/hassbian/customization/ To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of suites that can easily be installed or upgraded for easier customization of your Home Assistant installation. The tool is available by running `hassbian-config`. -### Install scripts -To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. -These are some of the available suites: - - [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md) - - [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md) - - [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md) - - [Fail2Ban](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/fail2ban.md) **This suite can't be installed on Raspberry Pi Zero** - - [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_ - - [Hue](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hue.md) - - [Hassbian Manager](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/manager.md) is a web UI tool that can help you manage your suites. - - [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mosquitto.md) - - [Pi-hole](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/pihole.md) - - [Razberry](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/razberry.md) - - [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/samba.md) - - [Trådfri](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/tradfri.md) - - [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/webterminal.md) - - [Zigbee2mqtt](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/zigbee2mqtt.md) - - Various database engines. - - [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mariadb.md) - - [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/postgresql.md) - - [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mssql.md) +### {% linkable_title Install scripts %} - To install any of them simply run `sudo hassbian-config install SUITE`. +To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. +These are some of the available suites: + +- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md) +- [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md) +- [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md) +- [Fail2Ban](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/fail2ban.md) **This suite can't be installed on Raspberry Pi Zero** +- [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_ +- [Hue](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hue.md) +- [Hassbian Manager](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/manager.md) is a web UI tool that can help you manage your suites. +- [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mosquitto.md) +- [Pi-hole](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/pihole.md) +- [Razberry](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/razberry.md) +- [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/samba.md) +- [Trådfri](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/tradfri.md) +- [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/webterminal.md) +- [Zigbee2mqtt](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/zigbee2mqtt.md) +- Various database engines. + - [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mariadb.md) + - [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/postgresql.md) + - [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mssql.md) + +To install any of them simply run `sudo hassbian-config install SUITE`. + +### {% linkable_title Upgrade scripts %} + +To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. +These are some of the available suites: -### Upgrade scripts -To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. -These are some of the available suites: - [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md) - [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md) - [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md) diff --git a/source/_docs/installation/hassbian/integrations.markdown b/source/_docs/installation/hassbian/integrations.markdown index 9e16275662d..aea7b972b5f 100644 --- a/source/_docs/installation/hassbian/integrations.markdown +++ b/source/_docs/installation/hassbian/integrations.markdown @@ -10,13 +10,13 @@ footer: true redirect_from: /docs/hassbian/integrations/ --- -Some integrations that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the `pi` account. For full documentation of these integrations refer to the [components](/components) page. +Some integrations that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the `pi` account. For full documentation of these integrations refer to the [integrations](/components) page. ### {% linkable_title Bluetooth Tracker %} The Bluetooth tracker will work on a Raspberry Pi 3 with the built-in Bluetooth module or with a USB Bluetooth device on any of the other Raspberry Pi's. -Software needed for the tracker is pre-installed so just follow the [Bluetooth Tracker component](/components/device_tracker.bluetooth_tracker/) and [Device Tracker page](/components/device_tracker/) pages. +Software needed for the tracker is pre-installed so just follow the [Bluetooth Tracker integration](/components/bluetooth_tracker/) and [Device Tracker page](/components/device_tracker/) pages. ### {% linkable_title Raspberry Pi GPIO %} @@ -26,11 +26,11 @@ For more details about the GPIO layout, visit the [documentation](https://www.ra Permission have been given to the `homeassistant` user to use the GPIO pins and all of the following integrations should require no underlying changes to work. Just follow the integration pages for each on how to add them to your Home Assistant installation. - - [DHT Sensor](/components/sensor.dht/) - - [Raspberry Pi Cover](/components/cover.rpi_gpio/) - - [Raspberry Pi GPIO Binary Sensor](/components/binary_sensor.rpi_gpio/) - - [Raspberry Pi GPIO Switch](/components/switch.rpi_gpio/) - - [Raspberry Pi RF Switch](/components/switch.rpi_rf/) + - [DHT Sensor](/components/dht/) + - [Raspberry Pi Cover](/components/rpi_gpio/#cover) + - [Raspberry Pi GPIO Binary Sensor](/components/rpi_gpio/#binary-sensor) + - [Raspberry Pi GPIO Switch](/components/rpi_gpio/#switch) + - [Raspberry Pi RF Switch](/components/rpi_rf/) ### {% linkable_title Raspberry Pi Camera %} @@ -44,7 +44,7 @@ $ sudo raspi-config Go to `Interfacing Options`, select `Enable camera` choose `` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot. -After this follow the [Raspberry Pi Camera component](/components/camera.rpi_camera/) page. +After this follow the [Raspberry Pi Camera integration](/components/rpi_camera/) page. ### {% linkable_title One wire Sensor %} @@ -53,4 +53,4 @@ To enable One Wire support add the following line to the end of `/boot/config.tx ```yaml dtoverlay=w1-gpio ``` -After this follow the [One Wire Sensor component](/components/sensor.onewire/) page. +After this follow the [One Wire Sensor integration](/components/onewire/) page. diff --git a/source/_docs/installation/hassbian/upgrading.markdown b/source/_docs/installation/hassbian/upgrading.markdown index 1a6b37d4968..16c0c46c51a 100644 --- a/source/_docs/installation/hassbian/upgrading.markdown +++ b/source/_docs/installation/hassbian/upgrading.markdown @@ -19,6 +19,7 @@ $ sudo apt-get -y upgrade ``` #### {% linkable_title Updating Home Assistant %} +

You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant`