Extends textlint Terminology list; part 3 (home-assistant#12069)

* Extends textlint Terminology list; part 3 * Fix apcupsd
ghigo · Feb 12, 2020 · bbdefa8 · bbdefa8
1 parent f0d37f4
commit bbdefa8
Show file tree

Hide file tree

Showing 35 changed files with 145 additions and 95 deletions.
diff --git a/.textlintrc.json b/.textlintrc.json
@@ -9,6 +9,8 @@
       "skip": ["Blockquote"],
       "terms": [
         " API ",
+        "ABB Solar PV",
+        "ABB",
         "Abode",
         "Acer",
         "Actiontec",
@@ -32,23 +34,55 @@
         "Ambiclimate",
         "Ambient Weather Station",
         "Amcrest",
+        "Ampio Smart Smog System",
+        "Android IP Webcam",
         "Android",
+        "Ankuoo REC Switch",
+        "Ankuoo",
+        "Antifurto365",
+        "Apache Kafka",
+        "Apache",
+        "APC Smart UPS",
+        "apcupsd",
+        "APNS",
+        "Apple iCloud",
+        "Apple TV",
         "AppleScript",
+        "Apprise",
+        "AquaLogic",
+        "aREST",
+        "Arlo",
+        "Aruba",
+        "Arube ClearPass",
+        "ASUS",
+        "ASUS",
+        "ASUSWRT",
+        "ATEN",
+        "Atome",
+        "August",
+        "Avi-on",
+        "AVM FRITZ!Box",
         "AWS",
         "Axis",
         "Beckhoff",
+        "BSSID",
         "Cisco IOS",
         "Dark Sky",
         "deCONZ",
         "DNS",
+        "Docker Hub",
+        "Docker",
         "ecobee",
         "Elgato Key Light",
         "Elgato",
+        "Emoncms",
+        "Entur",
         "ESPHome",
         "Everspring",
         "FFmpeg",
         "Fibaro",
         "FreeNAS",
+        "FRITZ!Box",
         "GitHub",
         "Google Assistant",
         "Google Home",
@@ -71,39 +105,54 @@
         "iOS",
         "IoT",
         "IP",
+        "iTunes",
         "JSON",
+        "Kafka",
         "KEF",
+        "Let's Encrypt",
         "Life360",
+        "Linky",
         "Lovelace",
         "macOS",
         "Microsoft",
         "MikroTik",
         "MJPEG",
         "MQTT",
+        "NAS",
+        "Network Information Server",
+        "NGINX",
         "NodeMCU",
+        "Norway",
+        "OpenWrt",
+        "PDU",
         "Philips",
         "Plex Media Server",
         "Plex",
         "PTZ",
         "REST API",
         "RFXtrx",
         "RouterOS",
+        "RTSP",
         "Samung",
         "Sentry",
         "Signal Messenger",
         "SmartThings",
         "Sonos",
         "Spotify",
+        "SSID",
         "SSL",
         "Stookalert",
         "Sure Petcare",
+        "Synology",
         "Tahoma",
         "TCP/IP",
         "TMB",
         "TwinCAT",
         "Twitter",
         "UART",
         "UI",
+        "unRAID",
+        "UPS",
         "URL",
         "Velbus",
         "Vera",
@@ -121,6 +170,7 @@
         ["Alarm ?dot ?com", "Alarm.com"],
         ["an URL", "a URL"],
         ["API['’]?s", "APIs"],
+        ["FRITZ!? ?Box", "FRITZ!Box"],
         ["hass", "Home Assistant"],
         ["Home-?Ass?s?iss?tt?ant", "Home Assistant"],
         ["Mac ?OS", "macOS"],

diff --git a/source/_docs/autostart/synology.markdown b/source/_docs/autostart/synology.markdown
@@ -6,7 +6,7 @@ redirect_from: /getting-started/autostart-synology/
 
 To get Home Assistant to automatically start when you boot your Synology NAS:
 
-SSH into your synology & login as admin or root
+SSH into your Synology & login as admin or root
 
 ```bash
 $ cd /volume1/homeassistant
@@ -32,13 +32,13 @@ exec /bin/sh /volume1/homeassistant/hass-daemon start
 Register the autostart
 
 ```bash
-$ ln -s homeassistant.conf /etc/init/homeassistant.conf
+ln -s homeassistant.conf /etc/init/homeassistant.conf
 ```
 
 Make the relevant files executable:
 
 ```bash
-$ chmod -r 777 /etc/init/homeassistant.conf
+chmod -r 777 /etc/init/homeassistant.conf
 ```
 
 That's it - reboot your NAS and Home Assistant should automatically start
diff --git a/source/_docs/ecosystem/appdaemon/updating.markdown b/source/_docs/ecosystem/appdaemon/updating.markdown
@@ -7,7 +7,7 @@ redirect_from: /ecosystem/appdaemon/updating/
 To update AppDaemon after I have released new code, just run the following command to update your copy:
 
 ```bash
-$ sudo pip3 install --upgrade appdaemon
+sudo pip3 install --upgrade appdaemon
 ```
 
-If you are using docker, rerun the steps to grab the latest docker image.
+If you are using Docker, rerun the steps to grab the latest Docker image.
diff --git a/source/_docs/ecosystem/nginx.markdown b/source/_docs/ecosystem/nginx.markdown
@@ -10,8 +10,7 @@ Using NGINX as a proxy for Home Assistant allows you to serve Home Assistant sec
 
 Chances are, you have a dynamic IP address (your ISP changes your address periodically). If this is true, you can use a Dynamic DNS service to obtain a domain and set it up to update with you IP. If you purchase your own domain name, you will be able to easily get a trusted SSL certificate later.
 
-
-### 2 Install nginx on your server
+### 2 Install NGINX on your server
 
 This will vary depending on your OS. Check out Google for this. After installing, ensure that NGINX is not running.
 
@@ -24,7 +23,8 @@ You will at least need nginx >= 1.3.13, as WebSocket support is required for the
 There are two ways of obtaining an SSL certificate.
 
 #### Using Let's Encrypt
-If you purchased your own domain, you can use https://letsencrypt.org/ to obtain a free, publicly trusted SSL certificate. This will allow you to work with services like IFTTT. Download and install per the instructions online and get a certificate using the following command.
+
+If you purchased your own domain, you can use <https://letsencrypt.org> to obtain a free, publicly trusted SSL certificate. This will allow you to work with services like IFTTT. Download and install per the instructions online and get a certificate using the following command.
 
 ```bash
 $ sudo ./letsencrypt-auto certonly --standalone -d example.com -d www.example.com
@@ -53,7 +53,7 @@ cd /etc/nginx/ssl
 sudo openssl dhparam -out dhparams.pem 2048
 ```
 
-### 5. Install configuration file in nginx.
+### 5. Install configuration file in NGINX
 
 Create a new file `/etc/nginx/sites-available/hass` and copy the configuration file at the bottom of the page into it.
 
@@ -63,19 +63,19 @@ Some Linux distributions (including CentOS and Fedora) will not have the `/etc/n
 
 </div>
 
-### 6. Enable the Home Assistant configuration.
+### 6. Enable the Home Assistant configuration
 
 ```bash
 cd /etc/nginx/sites-enabled
 sudo unlink default
 sudo ln ../sites-available/hass default
 ```
 
-### 7. Start NGINX.
+### 7. Start NGINX
 
-Double check this configuration to ensure all settings are correct and start nginx.
+Double check this configuration to ensure all settings are correct and start NGINX.
 
-### 8. Port forwarding.
+### 8. Port forwarding
 
 Forward ports 443 and 80 to your server on your router. Do not forward port 8123.
 

diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown
@@ -30,7 +30,7 @@ docker run --init -d --name="home-assistant" -e "TZ=America/New_York" -v /home/p
 
 When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the local timezone to your Docker container ([Docker issue](https://github.com/docker/for-mac/issues/44)). Instead of `-v /etc/localtime:/etc/localtime:ro`, just pass in the timezone environment variable when you launch the container, e.g, `-e "TZ=America/Los_Angeles"`. Replace "America/Los_Angeles" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
 
-If you wish to browse directly to `http://localhost:8123` from your macOS host, meaning forward ports directly to the container, replace the `--net=host` switch with `-p 8123:8123`. More detail can be found in [the docker forums](https://forums.docker.com/t/should-docker-run-net-host-work/14215/10).
+If you wish to browse directly to `http://localhost:8123` from your macOS host, meaning forward ports directly to the container, replace the `--net=host` switch with `-p 8123:8123`. More detail can be found in [the Docker forums](https://forums.docker.com/t/should-docker-run-net-host-work/14215/10).
 
 ```bash
 docker run --init -d --name="home-assistant" -e "TZ=America/Los_Angeles" -v /PATH_TO_YOUR_CONFIG:/config -p 8123:8123 homeassistant/home-assistant:stable
@@ -42,7 +42,7 @@ Alternatively, `docker-compose` works with any recent release of `docker-ce` on
 
 Docker containers are completely isolated from its Windows host system. So when you delete a container, all the changes you made to that container are also removed. If you want to have configuration files or other assets remain persistent, try mounting Windows folders on containers.
 
-Before proceeding, make sure you have shared out a drive for docker to mount to. This will allow the saving of config files to persist on the local machine rather than in the docker container (which may be destroyed when upgraded).
+Before proceeding, make sure you have shared out a drive for Docker to mount to. This will allow the saving of config files to persist on the local machine rather than in the Docker container (which may be destroyed when upgraded).
 
 <https://docs.docker.com/docker-for-windows/#shared-drives>
 <https://docs.docker.com/docker-for-windows/troubleshoot/#verify-domain-user-has-permissions-for-shared-drives-volumes>
@@ -64,11 +64,11 @@ netsh interface portproxy add v4tov4 listenaddress=192.168.1.10 listenport=8123
 netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=8123 connectaddress=10.0.50.2 connectport=8123
 ```
 
-This will let you access your Home Assistant portal from `http://localhost:8123`, and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the docker container.
+This will let you access your Home Assistant portal from `http://localhost:8123`, and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the Docker container.
 
 ### Synology NAS
 
-As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.synology.com/en-us/dsm/packages/Docker>
+As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using Docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.synology.com/en-us/dsm/packages/Docker>
 
 The steps would be:
 
@@ -131,13 +131,13 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assista
 
 ### QNAP NAS
 
-As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.qnap.com/solution/container_station/en/index.php>
+As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using Docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.qnap.com/solution/container_station/en/index.php>
 
 The steps would be:
 
 - Install "Container Station" package on your Qnap NAS
 - Launch Container Station and move to "Create Container"-section
-- Search image "homeassistant/home-assistant" with Docker hub and click on "Install"
+- Search image "homeassistant/home-assistant" with Docker Hub and click on "Install"
   Make attention to CPU architecture of your NAS. For ARM CPU types the correct image is "homeassistant/armhf-homeassistant"
 - Choose "latest" version and click next
 - Choose a container-name you want (e.g., "homeassistant")
@@ -156,7 +156,7 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB stick with Home Assista
 #### Z-Wave
 
 - Connect to your NAS over SSH
-- Load cdc-acm kernel module(when nas restart need to run this command)
+- Load cdc-acm kernel module(when NAS restart need to run this command)
   `insmod /usr/local/modules/cdc-acm.ko`
 - Find USB devices attached. Type command:
   `ls /dev/tty*`
@@ -202,7 +202,7 @@ If you change the configuration you have to restart the server. To do that you h
 
 ## Docker Compose
 
-As the docker command becomes more complex, switching to `docker-compose` can be preferable and support automatically restarting on failure or system restart. Create a `docker-compose.yml` file:
+As the Docker command becomes more complex, switching to `docker-compose` can be preferable and support automatically restarting on failure or system restart. Create a `docker-compose.yml` file:
 
 ```yaml
   version: '3'
@@ -232,7 +232,7 @@ docker-compose restart
 
 ## Exposing Devices
 
-In order to use Z-Wave, Zigbee or other integrations that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command:
+In order to use Z-Wave, Zigbee or other integrations that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your Docker command:
 
 ```bash
 $ docker run --init -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config \

diff --git a/source/_docs/installation/synology.markdown b/source/_docs/installation/synology.markdown
@@ -35,7 +35,7 @@ Using the Synology webadmin:
 - Install python3 using the Synology Package Center
 - Create a `homeassistant` user and add to the "users" group
 
-SSH onto your synology & login as admin or root
+SSH onto your Synology & login as admin or root
 
 - Log in with your own administrator account
 - Switch to root using:

diff --git a/source/_integrations/android_ip_webcam.markdown b/source/_integrations/android_ip_webcam.markdown
@@ -164,7 +164,7 @@ android_ip_webcam:
 
 ## Binary Sensor
 
-The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
+The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
 
 ## Examples
 
@@ -200,6 +200,6 @@ camera:
 
 ## Sensor
 
-The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
+The `android_ip_webcam` sensor platform lets you observe states of [Android IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
 
 You can setup your own sensors by examining the JSON file from the webcam server: `http://IP:8080/sensors.json`
diff --git a/source/_integrations/apcupsd.markdown b/source/_integrations/apcupsd.markdown
@@ -10,7 +10,7 @@ ha_release: 0.13
 ha_iot_class: Local Polling
 ---
 
-[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device.
+[Apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device.
 
 There is currently support for the following device types within Home Assistant:
 
@@ -34,26 +34,26 @@ apcupsd:
 
 {% configuration %}
 host:
-  description: The hostname/IP address on which the APCUPSd NIS is being served.
+  description: The hostname/IP address on which the apcupsd NIS is being served.
   required: false
   type: string
   default: localhost
 port:
-  description: The port on which the APCUPSd NIS is listening.
+  description: The port on which the apcupsd NIS is listening.
   required: false
   type: integer
   default: 3551
 {% endconfiguration %}
 
 <div class='note'>
 
-If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
+If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [Apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
 
  </div>
 
 ## Binary sensor
 
-In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
+In addition to the [Apcupsd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
 
 ### Configuration
 

diff --git a/source/_integrations/aruba.markdown b/source/_integrations/aruba.markdown
@@ -11,7 +11,7 @@ This platform allows you to detect presence by looking at connected devices to a
 
 Supported devices (tested):
 
-- ARUBA AP-105
+- Aruba AP-105
 
 <div class='note warning'>
 This device tracker needs telnet to be enabled on the router.

diff --git a/source/_integrations/asuswrt.markdown b/source/_integrations/asuswrt.markdown
@@ -1,6 +1,6 @@
 ---
-title: Asuswrt
-description: Instructions on how to integrate Asuswrt into Home Assistant.
+title: ASUSWRT
+description: Instructions on how to integrate ASUSWRT into Home Assistant.
 logo: asus.png
 ha_category:
   - Hub
@@ -16,8 +16,8 @@ The `asuswrt` integration is the main integration to connect to a [ASUSWRT](http
 
 There is currently support for the following device types within Home Assistant:
 
-- **Presence Detection** - The asuswrt platform offers presence detection by looking at connected devices to a ASUSWRT based router.
-- **Sensor** - The asuswrt sensor platform allows you to get upload and download data from your ASUSWRT within Home Assistant.
+- **Presence Detection** - The ASUSWRT platform offers presence detection by looking at connected devices to a ASUSWRT based router.
+- **Sensor** - The ASUSWRT sensor platform allows you to get upload and download data from your ASUSWRT within Home Assistant.
 
 ## Configuration
 

diff --git a/source/_integrations/aurora.markdown b/source/_integrations/aurora.markdown
@@ -7,7 +7,7 @@ ha_release: 0.39
 logo: noaa.png
 ---
 
-The `aurora` platform uses the [NOAA aurora forecast](https://www.swpc.noaa.gov/products/aurora-30-minute-forecast) service to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity.
+The `aurora` platform uses the [NOAA Aurora Forecast](https://www.swpc.noaa.gov/products/aurora-30-minute-forecast) service to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity.
 
 This service gives a number 0-100 representing the current likelihood of visible auroras at your latitude/longitude. By default this sensor is set up to trigger when the reported likelihood for your location is > 75. It updates every 5 minutes.