From c1eb75de1ad3f360caac034eb1e7f6eb10563dce Mon Sep 17 00:00:00 2001 From: Sean Smith Date: Wed, 3 Jul 2019 19:24:17 -0400 Subject: [PATCH] Add more settings helpers to widgets --- modules/bamboohr/settings.go | 4 ++-- modules/circleci/settings.go | 2 +- modules/clocks/settings.go | 8 ++++---- modules/cmdrunner/settings.go | 4 ++-- modules/datadog/settings.go | 6 +++--- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/modules/bamboohr/settings.go b/modules/bamboohr/settings.go index bfbba87c..6f781cec 100644 --- a/modules/bamboohr/settings.go +++ b/modules/bamboohr/settings.go @@ -12,8 +12,8 @@ const defaultTitle = "BambooHR" type Settings struct { common *cfg.Common - apiKey string - subdomain string + apiKey string `help:"Your BambooHR API token."` + subdomain string `help:"Your BambooHR API subdomain name."` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/circleci/settings.go b/modules/circleci/settings.go index 153300a5..44007ea4 100644 --- a/modules/circleci/settings.go +++ b/modules/circleci/settings.go @@ -12,7 +12,7 @@ const defaultTitle = "CircleCI" type Settings struct { common *cfg.Common - apiKey string + apiKey string `help:"Your CircleCI API token."` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/clocks/settings.go b/modules/clocks/settings.go index 0b7e8f51..af672430 100644 --- a/modules/clocks/settings.go +++ b/modules/clocks/settings.go @@ -19,10 +19,10 @@ type Settings struct { colors common *cfg.Common - dateFormat string - timeFormat string - locations map[string]interface{} - sort string + dateFormat string `help:"The format of the date string for all clocks." values:"Any valid Go date layout which is handled by Time.Format. Defaults to Jan 2."` + timeFormat string `help:"The format of the time string for all clocks." values:"Any valid Go time layout which is handled by Time.Format. Defaults to 15:04 MST."` + locations map[string]interface{} `help:"Defines the timezones for the world clocks that you want to display. key is a unique label that will be displayed in the UI. value is a timezone name." values:"Any TZ database timezone."` + sort string `help:"Defines the display order of the clocks in the widget." values:"'alphabetical' or 'chronological'. 'alphabetical' will sort in acending order by key, 'chronological' will sort in ascending order by date/time."` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/cmdrunner/settings.go b/modules/cmdrunner/settings.go index c6c12e1c..2fb4a223 100644 --- a/modules/cmdrunner/settings.go +++ b/modules/cmdrunner/settings.go @@ -11,8 +11,8 @@ const defaultTitle = "CmdRunner" type Settings struct { common *cfg.Common - args []string - cmd string + args []string `help:"The arguments to the command, with each item as an element in an array. Example: for curl -I cisco.com, the arguments array would be ["-I", "cisco.com"]."` + cmd string `help:"The terminal command to be run, withouth the arguments. Ie: ping, whoami, curl."` } func NewSettingsFromYAML(name string, moduleConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/datadog/settings.go b/modules/datadog/settings.go index de6ca75c..b7c9649f 100644 --- a/modules/datadog/settings.go +++ b/modules/datadog/settings.go @@ -12,9 +12,9 @@ const defaultTitle = "DataDog" type Settings struct { common *cfg.Common - apiKey string - applicationKey string - tags []interface{} + apiKey string `help:"Your Datadog API key."` + applicationKey string `help:"Your Datadog Application key."` + tags []interface{} `help:"Array of tags you want to query monitors by."` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {