From 487c4ab95b0caf726199e2efbc2e7d89d560aee3 Mon Sep 17 00:00:00 2001 From: Nicholas Westerhausen Date: Tue, 16 Oct 2018 12:54:25 -0400 Subject: [PATCH] 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. --- source/_components/notify.discord.markdown | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/source/_components/notify.discord.markdown b/source/_components/notify.discord.markdown index 16c82bbfc1f..5164e65a6c9 100644 --- a/source/_components/notify.discord.markdown +++ b/source/_components/notify.discord.markdown @@ -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 %}