Discord configuration variable format (#6864)

* Fix configuration variable format

Fix configuration variable format.
Modify example configuration.yaml snippet to be generic.

* Change description wording to be more clear.

Change description of 'name' to be clearer what the notifier name will be.
This commit is contained in:
Nicholas Westerhausen 2018-10-16 12:54:25 -04:00 committed by Fabian Affolter
parent f83175180c
commit 487c4ab95b

View File

@ -23,15 +23,21 @@ To use Discord notifications, add the following to your `configuration.yaml` fil
```yaml
# Example configuration.yaml entry
notify:
- name: NOTIFIER_NAME
platform: discord
token: A1aB2b.C3cD4d-E5eF6f
- platform: discord
token: YOUR_DISCORD_BOT_TOKEN
```
Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **token** (*Required*): Your bot's token.
{% configuration %}
name:
description: The notifier will bind to the service `notify.NAME`.
required: false
type: string
default: notify
token:
description: Your bot's token.
required: true
type: string
{% endconfiguration %}
### {% linkable_title Setting up the bot %}