Replace "docs" with "documentation" (home-assistant#12284)

* Replace "docs" with "documentation" * Blacklist docs in Textlint, use documentation instead * Fix more occurances Co-authored-by: Franck Nijhof <[email protected]>
chris-github1975 · Mar 10, 2020 · 52eda4f · 52eda4f
1 parent 57ac0bf
commit 52eda4f
Show file tree

Hide file tree

Showing 24 changed files with 34 additions and 33 deletions.
diff --git a/.textlintrc.json b/.textlintrc.json
@@ -303,6 +303,7 @@
         ["colour", "color"],
         ["config\\b", "configuration"],
         ["DarkSky", "Dark Sky"],
+        ["docs\\b", "documentation"],
         ["e\\.g\\.", "e.g.,"],
         ["end ?to ?end", "end-to-end"],
         ["FRITZ!? ?Box", "FRITZ!Box"],

diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown
@@ -44,7 +44,7 @@ If you wish to browse directly to `http://localhost:8123` from your macOS host,
 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
 ```
 
-Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/network/). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates.
+Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking documentation](https://docs.docker.com/network/). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates.
 
 ### Windows
 

diff --git a/source/_docs/installation/virtualenv.markdown b/source/_docs/installation/virtualenv.markdown
@@ -98,7 +98,7 @@ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@de
 
 - In the future, if you want to start Home Assistant manually again, follow step 2, 3 and 5.
 - It's recommended to run Home Assistant as a dedicated user.
-- If you want Home Assistant to automatically start at boot, check the [autostart docs](/docs/autostart/)
+- If you want Home Assistant to automatically start at boot, check the [autostart documentation](/docs/autostart/)
 
 <div class='info'>
  

diff --git a/source/_docs/tools/credstash.markdown b/source/_docs/tools/credstash.markdown
@@ -5,7 +5,7 @@ description: "Script to store credentials securely in AWS"
 
 Using [Credstash](https://github.com/fugue/credstash) is an alternative way to `secrets.yaml`. They can be managed from the command line via the credstash script.
 
-Before using credstash, you need to set up AWS credentials either via the `aws` command line tool or using environment variables as explained in the [AWS CLI docs](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named `credstash` as explained in the [credstash Readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash.
+Before using credstash, you need to set up AWS credentials either via the `aws` command line tool or using environment variables as explained in the [AWS CLI documentation](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named `credstash` as explained in the [credstash Readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash.
 
 ```bash
 $ hass --script credstash --help

diff --git a/source/_docs/z-wave/devices.markdown b/source/_docs/z-wave/devices.markdown
@@ -59,7 +59,7 @@ Where a device doesn't send updates on status changes to the controller, you can
 
 For example, with `polling_interval=60000` (which is the default) if you have 10 devices that are being polled at every interval, and each polling takes one secound (request/response round trip), then it will take 10 seconds to complete the polling list. This only leaves 50 seconds left for normal traffic. The more devices you poll, and the shorter the interval, the less bandwidth that's available for normal traffic.
 
-Polling needs to be enabled per device, you can control this through the *polling intensity* (interval) of the device. See the [Node Management](/docs/z-wave/control-panel#z-wave-node-management) docs for details.
+Polling needs to be enabled per device, you can control this through the *polling intensity* (interval) of the device. See the [Node Management](/docs/z-wave/control-panel#z-wave-node-management) documentation for details.
 
 ## Central Scene support
 

diff --git a/source/_faq/missing-documentation.markdown b/source/_faq/missing-documentation.markdown
@@ -1,6 +1,6 @@
 ---
 title: "Missing Documentation"
-description: "The docs are missing or outdated"
+description: "The documentation is missing or outdated"
 ha_category: Documentation
 ---
 

diff --git a/source/_includes/site/header.html b/source/_includes/site/header.html
@@ -24,7 +24,7 @@
             {% endcomment %}
             <li><a href="/getting-started/">Getting started</a></li>
             <li><a href="/integrations/">Integrations</a></li>
-            <li><a href="/docs/">Docs</a></li>
+            <li><a href="/docs/">Documentation</a></li>
             <li><a href="/cookbook/">Examples</a></li>
             <li><a href="/blog/">Blog</a></li>
             <li><a href="/help/">Need help?</a></li>
@@ -35,7 +35,7 @@
       <div class='search-container' style='display: none'>
         <div class='search'>
           <i class="icon-search"></i>
-          <input id='search' placeholder='Search the docs…'>
+          <input id='search' placeholder='Search the documentation…'>
           <a href='#' class='close'><i class="icon-remove-sign"></i></a>
         </div>
       </div>

diff --git a/source/_integrations/alarmdecoder.markdown b/source/_integrations/alarmdecoder.markdown
@@ -87,7 +87,7 @@ autobypass:
   default: false
   type: boolean
 zones:
-  description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/alarmdecoder) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*"
+  description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/alarmdecoder) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*"
   required: false
   type: list
   keys:

diff --git a/source/_integrations/automation.markdown b/source/_integrations/automation.markdown
@@ -10,7 +10,7 @@ ha_codeowners:
 ha_domain: automation
 ---
 
-Please see the [docs section](/docs/automation/) for in-depth
+Please see the [automation section](/docs/automation/) for in-depth
 documentation on how to use the automation integration.
 
 <p class='img'>

diff --git a/source/_integrations/aws.markdown b/source/_integrations/aws.markdown
@@ -103,7 +103,7 @@ context:
 
 ## Lambda Notify Usage
 
-AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.invoke).
+AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.invoke).
 
 The Lambda event payload will contain everything passed in the service call payload. Here is an example payload that would be sent to Lambda:
 
@@ -131,7 +131,7 @@ The context will look like this:
 
 ## SNS Notify Usage
 
-AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns.html#SNS.Client.publish).
+AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns.html#SNS.Client.publish).
 
 If one exists, the SNS Subject will be set to the title. All attributes from the payload, except the message, will be sent as stringified message attributes.
 
@@ -157,7 +157,7 @@ If you do not download them, you will lose them and will have to recreate a new
 
 ## SQS Notify Usage
 
-AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS docs](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) and [bototcore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS.Client.send_message)
+AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) and [bototcore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS.Client.send_message)
 
 The SQS event payload will contain everything passed in the service call payload. SQS payloads will be published as stringified JSON. All attributes from the payload, except message, will also be sent as stringified message attributes. Here is an example message that would be published to the SQS queue:
 

diff --git a/source/_integrations/bom.markdown b/source/_integrations/bom.markdown
@@ -34,7 +34,7 @@ name:
   required: false
   type: string
 station:
-  description: "The station ID string. See the [`sensor.bom` docs](#sensor) for details on how to find the ID of a station."
+  description: "The station ID string. See the [`sensor.bom` documentation](#sensor) for details on how to find the ID of a station."
   required: false
   type: string
   default: The closest station

diff --git a/source/_integrations/dialogflow.markdown b/source/_integrations/dialogflow.markdown
@@ -11,7 +11,7 @@ ha_domain: dialogflow
 
 The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
 
-To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
+To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
 
 Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms.
 

diff --git a/source/_integrations/envisalink.markdown b/source/_integrations/envisalink.markdown
@@ -105,7 +105,7 @@ panic_type:
   default: Police
   type: string
 zones:
-  description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/envisalink) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*"
+  description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/envisalink) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*"
   required: false
   type: integer
   keys:

diff --git a/source/_integrations/habitica.markdown b/source/_integrations/habitica.markdown
@@ -73,7 +73,7 @@ A successful call to this service will fire an event `habitica_api_call_success`
 |----------------------|--------|----------------|
 |  `name`                |   string   |  Copied from service data attribute. |
 | `path` | [string] | Copied from service data attribute. |
-| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see [docs](https://habitica.com/apidoc/). |
+| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see the [API documentation](https://habitica.com/apidoc/). |
 
 #### Let's consider some examples on how to call the service.
 
@@ -87,7 +87,7 @@ So let's call the API on `habitica.api_call`.
   * Remove `https://habitica.com/api/v3/` at the beginning of the endpoint URL.
   * Split the remaining on slashes (/) and **append the lowercase method** at the end.
   * You should get `["tasks", "user", "post"]`. To get a better idea of the API you are recommended to try all of the API calls in IPython console [using this package](https://github.com/ASMfreaK/habitipy/blob/master/README.md).
-* The `args` key is more or less described in the [docs](https://habitica.com/apidoc/).
+* The `args` key is more or less described in the [API documentation](https://habitica.com/apidoc/).
 
 Combining all together:
 call `habitica.api_call` with data

diff --git a/source/_integrations/html5.markdown b/source/_integrations/html5.markdown
@@ -90,7 +90,7 @@ The `html5` platform can only function if all of the following requirements are
 
 ### Configuring the platform
 
-1. Make sure you can access your Home Assistant installation from outside your network over HTTPS ([see docs](/docs/configuration/remote/)) or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant.
+1. Make sure you can access your Home Assistant installation from outside your network over HTTPS ([see documentation](/docs/configuration/remote/)) or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant.
 2. Create a new project at [https://console.cloud.google.com/home/dashboard](https://console.cloud.google.com/home/dashboard), this project will be imported into Firebase later (alternatively, the project can also be created during step 4).
 3. Go to [https://console.cloud.google.com/apis/credentials/domainverification](https://console.cloud.google.com/apis/credentials/domainverification) and verify your domain via Google Webmaster Central / Search Console - [see below](#verify-your-domain).
 4. With the domain verified, go to [https://console.firebase.google.com](https://console.firebase.google.com), select import Google project and select the project you created.

diff --git a/source/_integrations/hue.markdown b/source/_integrations/hue.markdown
@@ -1,4 +1,4 @@
----
+--
 title: Philips Hue
 description: Instructions on setting up Philips Hue within Home Assistant.
 ha_category:
@@ -148,4 +148,4 @@ The Hue API doesn't activate scenes directly; rather, they must be associated wi
 
 Neither group names nor scene names are guaranteed unique in Hue. If you are observing unexpected behavior from calling Hue scenes in Home Assistant, make the names of your Hue scenes more specific in the Hue app.
 
-The Hue hub has limited space for scenes and will delete scenes if new ones get created that would overflow that space. The API docs say this is based on the scenes that are "least recently used."
+The Hue hub has limited space for scenes and will delete scenes if new ones get created that would overflow that space. The API documentation says this is based on the scenes that are "least recently used."
diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown
@@ -14,7 +14,7 @@ ha_domain: ifttt
 
 ## Sending events from IFTTT to Home Assistant
 
-To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)).
+To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)).
 
 ### Setting up the integration
 

diff --git a/source/_integrations/mailgun.markdown b/source/_integrations/mailgun.markdown
@@ -9,7 +9,7 @@ ha_config_flow: true
 ha_domain: mailgun
 ---
 
-To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)).
+To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)).
 
 To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun.
 

diff --git a/source/_integrations/minio.markdown b/source/_integrations/minio.markdown
@@ -10,7 +10,7 @@ ha_domain: minio
 ---
 
 This integration adds interaction with [Minio](https://min.io).
-Also enables to listen for bucket notifications: [watch docs](https://docs.min.io/docs/minio-client-complete-guide.html#watch)
+It also enables listening for bucket notifications: [see documentation](https://docs.min.io/docs/minio-client-complete-guide.html#watch)
 
 To download or upload files, folders must be added to [whitelist_external_dirs](/docs/configuration/basic/).
 

diff --git a/source/_integrations/rocketchat.markdown b/source/_integrations/rocketchat.markdown
@@ -45,6 +45,6 @@ rocketchat_notification:
 #### Message variables
 
 - **message** (*Required*): Message to be displayed.
-- **data** (*Optional*): Dictionary containing any of the variables defined in the [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example)
+- **data** (*Optional*): Dictionary containing any of the variables defined in the [Rocket.Chat documentation](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example)
 
 To use notifications, please see the [getting started with automation page](/getting-started/automation/).