jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-17 06:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Bump textlint-rule-terminology from 3.0.1 to 3.0.2 (#23187)

Browse Source 
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
dependabot[bot] 2022-06-28 16:42:59 +02:00 committed by GitHub
parent 66af2ed936
commit 066f4dc075
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 59 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.textlintrc.json
View File

@ -1,5 +1,7 @@
{
"filters": {},
"filters": {
"comments": true
},
"rules": {
"common-misspellings": {
"ignore": ["Proove", "Alot"]

31
package-lock.json generated
View File

@ -15,8 +15,9 @@
"remark-lint-no-shell-dollars": "^3.1.1",
"remark-stringify": "^10.0.2",
"textlint": "^12.2.1",
"textlint-filter-rule-comments": "^1.2.2",
"textlint-rule-common-misspellings": "^1.0.1",
"textlint-rule-terminology": "^3.0.1"
"textlint-rule-terminology": "^3.0.2"
}
},
"node_modules/@azu/format-text": {
@ -5330,6 +5331,15 @@
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
}
},
"node_modules/textlint-filter-rule-comments": {
"version": "1.2.2",
"resolved": "https://registry.npmjs.org/textlint-filter-rule-comments/-/textlint-filter-rule-comments-1.2.2.tgz",
"integrity": "sha512-AtyxreCPb3Hq/bd6Qd6szY1OGgnW34LOjQXAHzE8NoXbTUudQqALPdRe+hvRsf81rnmGLxBiCUXZbnbpIseFyw==",
"dev": true,
"peerDependencies": {
"textlint": ">=6.8.0"
}
},
"node_modules/textlint-rule-common-misspellings": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/textlint-rule-common-misspellings/-/textlint-rule-common-misspellings-1.0.1.tgz",
@ -5374,9 +5384,9 @@
}
},
"node_modules/textlint-rule-terminology": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-3.0.1.tgz",
"integrity": "sha512-jk2SGGep+XBckhIm9u6CG7NeMZiosJRPfoh7ISlCZizj/JGNk/zheDYGVXwKbFu20SxsguyUIpTF1z/d1Q+NeQ==",
"version": "3.0.2",
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-3.0.2.tgz",
"integrity": "sha512-PgHg7wkf0gWbihSL+GZF+rG8GJX01azQXIUtWZ4UniDs5GwcwXpb98Dts8jrFQ+c9UeLb1u2HtBgjTmlWkWlQw==",
"dev": true,
"dependencies": {
"lodash": "^4.17.15",
@ -10014,6 +10024,13 @@
"unique-concat": "^0.2.2"
}
},
"textlint-filter-rule-comments": {
"version": "1.2.2",
"resolved": "https://registry.npmjs.org/textlint-filter-rule-comments/-/textlint-filter-rule-comments-1.2.2.tgz",
"integrity": "sha512-AtyxreCPb3Hq/bd6Qd6szY1OGgnW34LOjQXAHzE8NoXbTUudQqALPdRe+hvRsf81rnmGLxBiCUXZbnbpIseFyw==",
"dev": true,
"requires": {}
},
"textlint-rule-common-misspellings": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/textlint-rule-common-misspellings/-/textlint-rule-common-misspellings-1.0.1.tgz",
@ -10060,9 +10077,9 @@
}
},
"textlint-rule-terminology": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-3.0.1.tgz",
"integrity": "sha512-jk2SGGep+XBckhIm9u6CG7NeMZiosJRPfoh7ISlCZizj/JGNk/zheDYGVXwKbFu20SxsguyUIpTF1z/d1Q+NeQ==",
"version": "3.0.2",
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-3.0.2.tgz",
"integrity": "sha512-PgHg7wkf0gWbihSL+GZF+rG8GJX01azQXIUtWZ4UniDs5GwcwXpb98Dts8jrFQ+c9UeLb1u2HtBgjTmlWkWlQw==",
"dev": true,
"requires": {
"lodash": "^4.17.15",

4
package.json
View File

@ -2,7 +2,6 @@
"name": "home-assistant.io",
"description": "Home Assistant Website & Documentation",
"version": "1.0.0",
"dependencies": {},
"devDependencies": {
"remark-cli": "^11.0.0",
"remark-frontmatter": "^4.0.1",
@ -11,8 +10,9 @@
"remark-lint-no-shell-dollars": "^3.1.1",
"remark-stringify": "^10.0.2",
"textlint": "^12.2.1",
"textlint-filter-rule-comments": "^1.2.2",
"textlint-rule-common-misspellings": "^1.0.1",
"textlint-rule-terminology": "^3.0.1"
"textlint-rule-terminology": "^3.0.2"
},
"resolutions": {
"minimist": ">=1.2.5"

2
source/_integrations/amcrest.markdown
View File

@ -86,7 +86,7 @@ stream_source:
default: snapshot
ffmpeg_arguments:
description: >
Extra options to pass to ffmpeg, e.g.,
Extra options to pass to FFmpeg, e.g.,
image quality or video filter options.
required: false
type: string

2
source/_integrations/blink.markdown
View File

@ -99,7 +99,7 @@ The following are some examples showing how to correctly make service calls usin
### Snap Picture and Save Locally
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](/integrations/camera#service-snapshot)
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in Home Assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](/integrations/camera#service-snapshot)
```yaml
alias: "Blink Snap Picture"

2
source/_integrations/cast.markdown
View File

@ -33,7 +33,7 @@ Ignore CEC:
## Home Assistant Cast
Home Assistant has its own Cast application to show the Home Assistant UI on any Chromecast device. You can use it by adding the [Cast entity row](/dashboards/entities/#cast) to your dashboards, or by calling the `cast.show_lovelace_view` service. The service takes the path of a dashboard view and an entity ID of a Cast device to show the view on. A `path` has to be defined in your dashboard's YAML for each view, as outlined in the [views documentation](/dashboards/views/#path). The `dashboard_path` is the part of the dashboard URL that follows the defined `base_url`, typically "lovelace". The following is a full configuration for a script that starts casting the `downstairs` tab of the `lovelace-cast` path (note that `entity_id` is specified under `data` and not for the service call):
Home Assistant has its own Cast application to show the Home Assistant UI on any Chromecast device. You can use it by adding the [Cast entity row](/dashboards/entities/#cast) to your dashboards, or by calling the `cast.show_lovelace_view` service. The service takes the path of a dashboard view and an entity ID of a Cast device to show the view on. A `path` has to be defined in your dashboard's YAML for each view, as outlined in the [views documentation](/dashboards/views/#path). The `dashboard_path` is the part of the dashboard URL that follows the defined `base_url`, typically "`lovelace`". The following is a full configuration for a script that starts casting the `downstairs` tab of the `lovelace-cast` path (note that `entity_id` is specified under `data` and not for the service call):
```yaml
cast_downstairs_on_kitchen:

2
source/_integrations/delijn.markdown
View File

@ -37,7 +37,7 @@ sensor:
{% configuration %}
api_key:
description: "API Subscription key needed to access De Lijn API's."
description: "API Subscription key needed to access De Lijn APIs."
required: true
type: string
next_departure:

2
source/_integrations/doods.markdown
View File

@ -149,7 +149,7 @@ labels:
## Supported labels
Both detectors "default" and "tensorflow" use the labels in [this file](https://raw.githubusercontent.com/amikelive/coco-labels/master/coco-labels-2014_2017.txt).
Both detectors `default` and `tensorflow` use the labels in [this file](https://raw.githubusercontent.com/amikelive/coco-labels/master/coco-labels-2014_2017.txt).
## Sample configuration

6
source/_integrations/fail2ban.markdown
View File

@ -103,15 +103,15 @@ datepattern = ^%%Y-%%m-%%d %%H:%%M:%%S
#### Map log file directories
First, we need to make sure that fail2ban log can be passed to Home Assistant and that the Home Assistant log can be passed to fail2ban. When starting the Let's Encrypt docker, you need to add the following argument (adjust paths based on your setup):
First, we need to make sure that fail2ban log can be passed to Home Assistant and that the Home Assistant log can be passed to fail2ban. When starting the Let's Encrypt Docker, you need to add the following argument (adjust paths based on your setup):
```txt
/mnt/user/appdata/home-assistant:/hass
```
This will map the Home Assistant configuration directory to the Let's Encrypt docker, allowing `fail2ban` to parse the log for failed login attempts.
This will map the Home Assistant configuration directory to the Let's Encrypt Docker, allowing `fail2ban` to parse the log for failed login attempts.
Now do the same for the Home Assistant docker, but this time we'll be mapping the `fail2ban` log directory to Home Assistant so that the fail2ban sensor is able to read that log:
Now do the same for the Home Assistant Docker, but this time we'll be mapping the `fail2ban` log directory to Home Assistant so that the fail2ban sensor is able to read that log:
```txt
/mnt/user/appdata/letsencrypt/log/fail2ban:/fail2ban

2
source/_integrations/flic.markdown
View File

@ -17,7 +17,7 @@ The platform does not directly interact with the buttons, *but communicates with
## Service setup
If you are using Hass.io, you can run the service locally by [installing](/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons).
If you are using the Home Assistant Operating System, you can run the service locally by [installing](/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons).
For instructions on how to install the service manually, visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [macOS](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).

2
source/_integrations/foursquare.markdown
View File

@ -71,7 +71,7 @@ Parameters:
- **eventId** (*Optional*): The event the user is checking in to.
- **shout** (*Optional*): A message about your check-in. The maximum length of this field is 140 characters.
- **mentions** (*Optional*): Mentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form "start,end,userid", where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with "fbu-", this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based.
- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), Facebook share on Facebook, Twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), Facebook share on Facebook, Twitter share on Twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
- **ll** (*Optional*): Latitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in.
- **llAcc** (*Optional*): Accuracy of the user's latitude and longitude, in meters.
- **alt** (*Optional*): Altitude of the user's location, in meters.

2
source/_integrations/google.markdown
View File

@ -31,7 +31,7 @@ This section explains how to generate a Client ID and Client Secret on
1. When it gets to the Page titled _Add credentials to your project_ just click cancel.
1. Navigate to APIs & Services (left sidebar) > Credentials
1. Click on the field on the right of the screen, 'CONFIGURE CONSENT SCREEN', select "External" and create.
1. Set the 'Application Name' (the name of the application asking for consent) to anything you want. We suggest "Home-Assistant".
1. Set the 'Application Name' (the name of the application asking for consent) to anything you want. We suggest `Home-Assistant`.
1. You then need to select a `Support email`. To do this, simply click the drop down box and select your email address.
1. You finally need to complete the section: `Developer contact information`. To do this, simply enter your email address (same as above is fine).
1. Scroll to the bottom and click `save`. (You don't have to fill out anything else)

2
source/_integrations/homematic.markdown
View File

@ -209,7 +209,7 @@ Resolving names can take some time. So when you start Home Assistant you won't s
### Multiple hosts
In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters.
In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and IP), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters.
Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host.
This does *not* affect the entities in Home Assistant. They all use their own connection and work as expected.

2
source/_integrations/http.markdown
View File

@ -153,7 +153,7 @@ If you want to use Home Assistant to host or serve static files then create a di
<div class='note warning'>
Files served from the `www` folder (`/local/` url), aren't protected by the Home Assistant authentication. Files stored in this folder, if the URL is known, can be accessed by anybody without authentication.
Files served from the `www` folder (`/local/` URL), aren't protected by the Home Assistant authentication. Files stored in this folder, if the URL is known, can be accessed by anybody without authentication.
</div>

2
source/_integrations/icloud.markdown
View File

@ -42,7 +42,7 @@ If two-step authentication is enabled for your iCloud account, some time after H
## In case of troubleshooting
Go into your Home Assistant configuration `.storage` folder and delete the "icloud" folder, then retry.
Go into your Home Assistant configuration `.storage` folder and delete the `icloud` folder, then retry.
## Platforms

2
source/_integrations/nmap_tracker.markdown
View File

@ -53,7 +53,7 @@ Raw configurable scan options for Nmap:
### Linux capabilities
On Linux systems (such as Hass.io) you can extend the functionality of Nmap, without having to run it as root, by using *Linux capabilities*. Be sure to specify the full path to wherever you installed Nmap:
On Linux systems (such as the Home Assistant Operating System) you can extend the functionality of Nmap, without having to run it as root, by using *Linux capabilities*. Be sure to specify the full path to wherever you installed Nmap:
```bash
sudo setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nmap

2
source/_integrations/nut.markdown
View File

@ -65,7 +65,7 @@ output.voltage.nominal: 120
```
Use the values from the left hand column. Support is included for most
values with 'ups', 'battery', 'input' and 'output' prefixes.
values with `ups`, `battery`, `input` and `output` prefixes.
## UPS Status - human-readable version

4
source/_integrations/octoprint.markdown
View File

@ -80,8 +80,12 @@ Supported sensors:
If the OctoPrint host is equipped with a web camera it is possible to add this as well using the [`MJPEG IP Camera`](/integrations/mjpeg) integration. Use `http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream` for the MJPEG URL and `http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=snapshot` as the still image URL.
<!-- textlint-disable -->
{% my config_flow_start badge domain="mjpeg" %}
<!-- textlint-enable -->
## Buttons
The OctoPrint integration provides the following buttons.

2
source/_integrations/point.markdown
View File

@ -77,7 +77,7 @@ The Point only supports a Arm/Disarm action, so it is only `Arm Away` that is im
Each Point exposes the following binary sensors:
- **alarm**: `On` means alarm sound was recognised, `Off` means normal
- **alarm**: `On` means alarm sound was recognized, `Off` means normal
- **battery**: `On` means low, `Off` means normal
- **button_press**: `On` means the button was pressed, `Off` means normal
- **cold**: `On` means cold, `Off` means normal

4
source/_integrations/proxmoxve.markdown
View File

@ -121,7 +121,7 @@ Privileges can be either applied to Groups or Roles.
1. Click `Datacenter`
2. Open `Permissions` and click `Groups`
3. Click the `Create` button above all the existing groups
4. Name the new group (e.g., "HomeAssistant")
4. Name the new group (e.g., `HomeAssistant`)
5. Click `Create`
### Add Group Permissions to all Assets
@ -143,7 +143,7 @@ Creating a dedicated user for Home Assistant, limited to only to the access just
1. Click `Datacenter`
2. Open `Permissions` and click `Users`
3. Click `Add`
4. Enter a username (e.g., "hass")
4. Enter a username (e.g.,` hass`)
5. Set the realm to "Proxmox VE authentication server"
6. Enter a secure password (it can be complex as you will only need to copy/paste it into your Home Assistant configuration)
7. Select the group just created earlier (`HomeAssistant`) to grant access to Proxmox

2
source/_integrations/sensor.rest.markdown
View File

@ -121,7 +121,7 @@ params:
required: false
type: [template, list]
json_attributes:
description: A list of keys to extract values from a JSON dictionary result and then set as sensor attributes. If the endpoint returns XML with the "text/xml", "application/xml" or "application/xhtml+xml" content type, it will automatically be converted to JSON according to this [specification](https://www.xml.com/pub/a/2006/05/31/converting-between-xml-and-json.html)
description: "A list of keys to extract values from a JSON dictionary result and then set as sensor attributes. If the endpoint returns XML with the `text/xml`, `application/xml`, or `application/xhtml+xml` content type, it will automatically be converted to JSON according to this [specification](https://www.xml.com/pub/a/2006/05/31/converting-between-xml-and-json.html)"
required: false
type: [string, list]
json_attributes_path:

2
source/_integrations/signal_messenger.markdown
View File

@ -94,7 +94,7 @@ action:
### Text message with an attachment from a URL
To attach files from outside of HomeAssistant, the URLs must be added to the [`allowlist_external_urls`](/docs/configuration/basic/#allowlist_external_urls) list.
To attach files from outside of Home Assistant, the URLs must be added to the [`allowlist_external_urls`](/docs/configuration/basic/#allowlist_external_urls) list.
Note there is a 50MB size limit for attachments retrieved via URLs. You can also set `verify_ssl` to `false` to ignore SSL errors (default `true`).

2
source/_integrations/squeezebox.markdown
View File

@ -58,7 +58,7 @@ It can also be used to target a Squeezebox from IFTTT (or Dialogflow, Alexa...).
For example, to play an album from your collection, create an IFTTT applet like this:
- Trigger: Google assistant, with sentence: `I want to listen to album $`
- Trigger: Google Assistant, with sentence: `I want to listen to album $`
- Action: JSON post query with such JSON body:
`{ "entity_id": "media_player.squeezebox_radio", "command": "playlist", "parameters": ["loadtracks", "album.titlesearch={{TextField}}"] }`

2
source/_integrations/tts.markdown
View File

@ -54,7 +54,7 @@ service_name:
description: Define the service name.
required: false
type: string
default: The service name default set to <platform>_say. For example, for google_translate tts, its service name default is `google_translate_say`.
default: The service name default set to <platform>_say. For example, for google_translate TTS, its service name default is `google_translate_say`.
{% endconfiguration %}
The extended example from above would look like the following sample:

2
source/_integrations/ubus.markdown
View File

@ -85,7 +85,7 @@ See the [device tracker integration page](/integrations/device_tracker/) for ins
## Troubleshooting
If you find that this never creates `known_devices.yaml`, or if you need more information on the communication chain between Home Assistant and OpenWRT, follow these steps to grab the packet stream and gain insight into what's happening.
If you find that this never creates `known_devices.yaml`, or if you need more information on the communication chain between Home Assistant and OpenWrt, follow these steps to grab the packet stream and gain insight into what's happening.
### Increase Log Level

2
source/_integrations/xmpp.markdown
View File

@ -148,7 +148,7 @@ Number 3 sends an image from a local path.
### Jabber File Message
Number 4 sends a text-file, retrieved from Github, renamed to `Hass_Cheatsheet.txt` to be viewable on a mobile Android device, as most don't offer any application to view `.md` files. Optionally you can add a timeout for the HTTP upload in seconds.
Number 4 sends a text-file, retrieved from GitHub, renamed to `Hass_Cheatsheet.txt` to be viewable on a mobile Android device, as most don't offer any application to view `.md` files. Optionally you can add a timeout for the HTTP upload in seconds.
```yaml
# Example script.yaml entry

2
source/_integrations/zwave_js.markdown
View File

@ -685,7 +685,7 @@ Once you have the Z-Wave server up and running, you need to install and configur
If you're running full Home Assistant with supervisor, you will be presented with a dialog that asks if you want to use the Z-Wave JS Supervisor add-on. You **must** uncheck this box if you are running the Z-Wave JS server in any manner other than the official Z-Wave JS add-on, including using Z-Wave JS to MQTT add-on.
If you're not running the supervisor or you've unchecked the above mentioned box, you will be asked to enter a websocket URL (defaults to ws://localhost:3000). It is very important that you fill in the correct (docker) IP/hostname here. For example for the Z-Wave JS to MQTT add-on this is `ws://a0d7b954-zwavejs2mqtt:3000`.
If you're not running the supervisor or you've unchecked the above mentioned box, you will be asked to enter a websocket URL (defaults to ws://localhost:3000). It is very important that you fill in the correct (Docker) IP/hostname here. For example for the Z-Wave JS to MQTT add-on this is `ws://a0d7b954-zwavejs2mqtt:3000`.
## Frequently Asked Questions