From ba402358e6962b481063c1f4f2f98b014bf502b5 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Wed, 16 May 2018 23:19:14 -0700 Subject: [PATCH] Simplifies the documentation pages --- .../content/posts/configuration/attributes.md | 6 +- _site/content/posts/modules/bamboohr.md | 4 +- _site/content/posts/modules/clocks.md | 4 +- _site/content/posts/modules/gcal.md | 4 +- _site/content/posts/modules/git.md | 4 +- _site/content/posts/modules/github.md | 4 +- _site/content/posts/modules/jira.md | 4 +- _site/content/posts/modules/newrelic.md | 4 +- _site/content/posts/modules/opsgenie.md | 4 +- _site/content/posts/modules/security.md | 4 +- _site/content/posts/modules/textfile.md | 4 +- _site/content/posts/modules/todo.md | 4 +- _site/content/posts/modules/weather.md | 4 +- .../layouts/partials/content_single.html | 14 ++--- docs/index.xml | 57 ++++++++++--------- .../posts/configuration/attributes/index.html | 23 ++++---- docs/posts/configuration/index.html | 13 +++-- docs/posts/glossary/index.html | 13 +++-- docs/posts/index.html | 26 ++++----- docs/posts/index.xml | 57 ++++++++++--------- docs/posts/modules/bamboohr/index.html | 21 ++++--- docs/posts/modules/clocks/index.html | 21 ++++--- docs/posts/modules/gcal/index.html | 21 ++++--- docs/posts/modules/git/index.html | 21 ++++--- docs/posts/modules/github/index.html | 21 ++++--- docs/posts/modules/index.html | 13 +++-- docs/posts/modules/jira/index.html | 21 ++++--- docs/posts/modules/newrelic/index.html | 21 ++++--- docs/posts/modules/opsgenie/index.html | 21 ++++--- docs/posts/modules/security/index.html | 21 ++++--- docs/posts/modules/textfile/index.html | 21 ++++--- docs/posts/modules/todo/index.html | 21 ++++--- docs/posts/modules/weather/index.html | 21 ++++--- wtf.go | 1 - 34 files changed, 246 insertions(+), 277 deletions(-) diff --git a/_site/content/posts/configuration/attributes.md b/_site/content/posts/configuration/attributes.md index 4e5dc9a5..1228a2a3 100644 --- a/_site/content/posts/configuration/attributes.md +++ b/_site/content/posts/configuration/attributes.md @@ -1,11 +1,11 @@ --- -title: "Attributes" +title: "Configuration: Attributes" date: 2018-05-16T21:51:23-07:00 draft: false --- -This page describes the top-level attributes that can be added to -`config.yml`. +The following top-level attributes are configurable in `config.yml`. +See this example config file for more details. ```yaml wtf: diff --git a/_site/content/posts/modules/bamboohr.md b/_site/content/posts/modules/bamboohr.md index 25f796c6..fbeded40 100644 --- a/_site/content/posts/modules/bamboohr.md +++ b/_site/content/posts/modules/bamboohr.md @@ -1,11 +1,9 @@ --- -title: "Bamboohr" +title: "Modules: Bamboohr" date: 2018-05-07T20:17:37-07:00 draft: false --- -## Description - Connects to the BambooHR API and displays who will be Away today. ## Source Code diff --git a/_site/content/posts/modules/clocks.md b/_site/content/posts/modules/clocks.md index 9a7534c4..512a13ce 100644 --- a/_site/content/posts/modules/clocks.md +++ b/_site/content/posts/modules/clocks.md @@ -1,11 +1,9 @@ --- -title: "Clocks" +title: "Modules: Clocks" date: 2018-05-07T19:47:31-07:00 draft: false --- -## Description - Displays a configurable list of world clocks, the local time, and date. clocks screenshot diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md index b20b77dd..29860761 100644 --- a/_site/content/posts/modules/gcal.md +++ b/_site/content/posts/modules/gcal.md @@ -1,11 +1,9 @@ --- -title: "Google Calendar" +title: "Modules: Google Calendar" date: 2018-05-10T08:25:33-07:00 draft: false --- -## Description - Displays your upcoming Google calendar events. gcal screenshot diff --git a/_site/content/posts/modules/git.md b/_site/content/posts/modules/git.md index c87153b4..763e2a40 100644 --- a/_site/content/posts/modules/git.md +++ b/_site/content/posts/modules/git.md @@ -1,11 +1,9 @@ --- -title: "Git" +title: "Modules: Git" date: 2018-05-09T14:20:48-07:00 draft: false --- -## Description - Displays information about local git repositories: branch, changed files, and recent commits. diff --git a/_site/content/posts/modules/github.md b/_site/content/posts/modules/github.md index 550411db..2dd3e6ca 100644 --- a/_site/content/posts/modules/github.md +++ b/_site/content/posts/modules/github.md @@ -1,11 +1,9 @@ --- -title: "Github" +title: "Modules: Github" date: 2018-05-09T19:20:20-07:00 draft: false --- -## Description - Displays information about git repositories hosted on Github: open review requests, and open pull requests. diff --git a/_site/content/posts/modules/jira.md b/_site/content/posts/modules/jira.md index 326a91d4..5b58fab0 100644 --- a/_site/content/posts/modules/jira.md +++ b/_site/content/posts/modules/jira.md @@ -1,11 +1,9 @@ --- -title: "Jira" +title: "Modules: Jira" date: 2018-05-10T10:44:35-07:00 draft: false --- -## Description - Displays all Jira issues assigned to you for the specified project. jira screenshot diff --git a/_site/content/posts/modules/newrelic.md b/_site/content/posts/modules/newrelic.md index bdbf3a8b..b8ca07d5 100644 --- a/_site/content/posts/modules/newrelic.md +++ b/_site/content/posts/modules/newrelic.md @@ -1,11 +1,9 @@ --- -title: "Newrelic" +title: "Modules: New Relic" date: 2018-05-09T09:01:14-07:00 draft: false --- -## Description - Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. diff --git a/_site/content/posts/modules/opsgenie.md b/_site/content/posts/modules/opsgenie.md index 84a81a56..ab2cc912 100644 --- a/_site/content/posts/modules/opsgenie.md +++ b/_site/content/posts/modules/opsgenie.md @@ -1,11 +1,9 @@ --- -title: "Opsgenie" +title: "Modules: OpsGenie" date: 2018-05-08T20:53:40-07:00 draft: false --- -## Description - Connects to the OpsGenie API and displays all your scheduled rotations and who's currently on call. diff --git a/_site/content/posts/modules/security.md b/_site/content/posts/modules/security.md index f79c75f5..1329e2d4 100644 --- a/_site/content/posts/modules/security.md +++ b/_site/content/posts/modules/security.md @@ -1,11 +1,9 @@ --- -title: "Security" +title: "Modules: Security" date: 2018-05-08T20:33:28-07:00 draft: false --- -## Description - Displays some general information about the state of the machine's wifi connection, firewall, and DNS settings. diff --git a/_site/content/posts/modules/textfile.md b/_site/content/posts/modules/textfile.md index 088022e0..1697523f 100644 --- a/_site/content/posts/modules/textfile.md +++ b/_site/content/posts/modules/textfile.md @@ -1,11 +1,9 @@ --- -title: "Textfile" +title: "Modules: Textfile" date: 2018-05-09T11:13:11-07:00 draft: false --- -## Description - Displays the contents of the specified text file in the widget. textfile screenshot diff --git a/_site/content/posts/modules/todo.md b/_site/content/posts/modules/todo.md index a703e960..248f956c 100644 --- a/_site/content/posts/modules/todo.md +++ b/_site/content/posts/modules/todo.md @@ -1,11 +1,9 @@ --- -title: "Todo" +title: "Modules: Todo" date: 2018-05-10T12:41:50-07:00 draft: false --- -## Description - An interactive todo list. todo screenshot diff --git a/_site/content/posts/modules/weather.md b/_site/content/posts/modules/weather.md index 15b6cc68..b8b745b3 100644 --- a/_site/content/posts/modules/weather.md +++ b/_site/content/posts/modules/weather.md @@ -1,11 +1,9 @@ --- -title: "Weather" +title: "Modules: Weather" date: 2018-05-09T11:44:13-07:00 draft: false --- -## Description - Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time. diff --git a/_site/themes/hyde-hyde/layouts/partials/content_single.html b/_site/themes/hyde-hyde/layouts/partials/content_single.html index 53905f8c..beffe035 100644 --- a/_site/themes/hyde-hyde/layouts/partials/content_single.html +++ b/_site/themes/hyde-hyde/layouts/partials/content_single.html @@ -3,9 +3,9 @@ {{ if ne .Params.showpagemeta false }}
- - {{ if not .Date.IsZero }} - {{ .Date.Format (.Site.Params.dateformat | default "Jan 02, 2006") -}} + + {{ if not .Date.IsZero }} + {{ .Date.Format (.Site.Params.dateformat | default "Jan 02, 2006") -}} {{ end }} {{ with .Params.categories }} @@ -31,9 +31,9 @@ {{ end }} {{ end }}
- {{ .ReadingTime }} min read - -
+ + + {{ end }} {{ .Content }} - \ No newline at end of file + diff --git a/docs/index.xml b/docs/index.xml index 432776d5..06fb8a20 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -12,22 +12,22 @@ - Attributes + Configuration: Attributes http://wtfutil.com/posts/configuration/attributes/ Wed, 16 May 2018 21:51:23 -0700 http://wtfutil.com/posts/configuration/attributes/ - This page describes the top-level attributes that can be added to config.yml. + The following top-level attributes are configurable in config.yml. See this example config file for more details. wtf:colors:border:Focusable:"darkslateblue"focused:"orange"normal:"gray"grid:# How _wide_ the columns are, in terminal characters. In this case we have# six columns, each of which are 35 characters widecolumns:[35,35,35,35,35,35]# How _high_ the rows are, in terminal lines. In this case we have five rows# that support ten line of text, one of three lines, and one of fourrows:[10,10,10,10,10,3,4]# The app redraws itself once a secondrefreshInterval:1 Attributes colors. - Todo + Modules: Todo http://wtfutil.com/posts/modules/todo/ Thu, 10 May 2018 12:41:50 -0700 http://wtfutil.com/posts/modules/todo/ - Description An interactive todo list. + An interactive todo list. Source Code wtf/todo/ Required ENV Variables None. Keyboard Commands Key: [return] Action: Edit the selected item. Action: Close the modal item dialog and save changes. Key: [esc] Action: Remove focus from the selected item. Action: Close the modal item dialog without saving changes. Key: [space] Action: Check/uncheck the selected item. @@ -36,12 +36,12 @@ Key: j Action: Select the next item in the list. - Jira + Modules: Jira http://wtfutil.com/posts/modules/jira/ Thu, 10 May 2018 10:44:35 -0700 http://wtfutil.com/posts/modules/jira/ - Description Displays all Jira issues assigned to you for the specified project. + Displays all Jira issues assigned to you for the specified project. Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key. Keyboard Commands None. Configuration jira:colors:rows:even:"lightblue"odd:"white"domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:trueposition:top:4left:1height:1width:2project:"CORE"refreshInterval:900username:"chris.cummer" Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name. @@ -51,12 +51,12 @@ email The email address associated with your Jira account. - Google Calendar + Modules: Google Calendar http://wtfutil.com/posts/modules/gcal/ Thu, 10 May 2018 08:25:33 -0700 http://wtfutil.com/posts/modules/gcal/ - Description Displays your upcoming Google calendar events. + Displays your upcoming Google calendar events. Source Code wtf/gcal/ Required ENV Variables Key: WTF_GOOGLE_CAL_CLIENT_ID Value: Your Google API client ID. Key: WTF_GOOGLE_CAL_CLIENT_SECRET Value: Your Google API client secret. Keyboard Commands None. @@ -66,12 +66,12 @@ colors.highlights A list of arrays that define a regular expression pattern and - Github + Modules: Github http://wtfutil.com/posts/modules/github/ Wed, 09 May 2018 19:20:20 -0700 http://wtfutil.com/posts/modules/github/ - Description Displays information about git repositories hosted on Github: open review requests, and open pull requests. + Displays information about git repositories hosted on Github: open review requests, and open pull requests. Open Review Requests All open code review requests assigned to you. Open Pull Requests All open pull requests created by you. Source Code wtf/github/ Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your Github API token. @@ -81,26 +81,27 @@ Key: l Action: Show the next git repository. - Git + Modules: Git http://wtfutil.com/posts/modules/git/ Wed, 09 May 2018 14:20:48 -0700 http://wtfutil.com/posts/modules/git/ - Description Displays information about local git repositories: branch, changed files, and recent commits. + Displays information about local git repositories: branch, changed files, and recent commits. Branch The name of the currently-active git branch. Changed Files A list of all the files that have changed since the last commit, and their status. Recent Commits A list of n recent commits, who committed it, and when. Source Code wtf/git/ Required ENV Variables None. -Keyboard Commands Key: / Action: Open/close the widget’s help window. +Keyboard Commands Key: / Action: Open/close the widget’s help window. +Key: h Action: Show the previous git repository. - Weather + Modules: Weather http://wtfutil.com/posts/modules/weather/ Wed, 09 May 2018 11:44:13 -0700 http://wtfutil.com/posts/modules/weather/ - Description Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time. + Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time. Source Code wtf/weather/ Required ENV Variables Key: WTF_OWM_API_KEY Action: Your OpenWeatherMap API key. Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: h Action: Show the previous weather location. @@ -110,12 +111,12 @@ Key: → Action: Show the next weather location. - Textfile + Modules: Textfile http://wtfutil.com/posts/modules/textfile/ Wed, 09 May 2018 11:13:11 -0700 http://wtfutil.com/posts/modules/textfile/ - Description Displays the contents of the specified text file in the widget. + Displays the contents of the specified text file in the widget. Source Code wtf/textfile/ Required ENV Variables None. Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: o Action: Opens the text file in whichever text editor is associated with that file type. @@ -124,12 +125,12 @@ filePath The path to the file to be displayed in the widget. - Newrelic + Modules: New Relic http://wtfutil.com/posts/modules/newrelic/ Wed, 09 May 2018 09:01:14 -0700 http://wtfutil.com/posts/modules/newrelic/ - Description Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. + Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. Source Code wtf/newrelic/ Required ENV Variables Key: WTF_NEW_RELIC_API_KEY Value: Your New Relic API token. Keyboard Commands None. Configuration newrelic:applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n. @@ -137,12 +138,12 @@ deployCount The number of past deploys to display on screen. - Opsgenie + Modules: OpsGenie http://wtfutil.com/posts/modules/opsgenie/ Tue, 08 May 2018 20:53:40 -0700 http://wtfutil.com/posts/modules/opsgenie/ - Description Connects to the OpsGenie API and displays all your scheduled rotations and who’s currently on call. + Connects to the OpsGenie API and displays all your scheduled rotations and who’s currently on call. Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token. Keyboard Commands None. Configuration opsgenie:displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false. @@ -151,36 +152,36 @@ position Where in the grid this module’s widget will be displayed. - Security + Modules: Security http://wtfutil.com/posts/modules/security/ Tue, 08 May 2018 20:33:28 -0700 http://wtfutil.com/posts/modules/security/ - Description Displays some general information about the state of the machine’s wifi connection, firewall, and DNS settings. + Displays some general information about the state of the machine’s wifi connection, firewall, and DNS settings. Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Source Code wtf/security Required ENV Variables None. - Bamboohr + Modules: Bamboohr http://wtfutil.com/posts/modules/bamboohr/ Mon, 07 May 2018 20:17:37 -0700 http://wtfutil.com/posts/modules/bamboohr/ - Description Connects to the BambooHR API and displays who will be Away today. + Connects to the BambooHR API and displays who will be Away today. Source Code wtf/bamboohr Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token. Key: WTF_BAMBOO_HR_SUBDOMAIN Value: Your BambooHR API subdomain name. Keyboard Commands None. Configuration bamboohr:enabled:trueposition:top:0left:1height:2width:1refreshInterval:900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. -position Defines where in the grid this module’s widget will be displayed. +position Defines where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. - Clocks + Modules: Clocks http://wtfutil.com/posts/modules/clocks/ Mon, 07 May 2018 19:47:31 -0700 http://wtfutil.com/posts/modules/clocks/ - Description Displays a configurable list of world clocks, the local time, and date. + Displays a configurable list of world clocks, the local time, and date. Source Code wtf/clocks/ Required ENV Variables None. Keyboard Commands None. Configuration clocks:colors:rows:even:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name. diff --git a/docs/posts/configuration/attributes/index.html b/docs/posts/configuration/attributes/index.html index 81329003..15fd5b27 100644 --- a/docs/posts/configuration/attributes/index.html +++ b/docs/posts/configuration/attributes/index.html @@ -10,8 +10,8 @@ -Attributes | WTF - +Configuration: Attributes | WTF + @@ -90,26 +90,26 @@
-

Attributes

+

Configuration: Attributes

- - - May 16, 2018 + + + May 16, 2018
- 1 min read - -
+ + +
-

This page describes the top-level attributes that can be added to -config.yml.

+

The following top-level attributes are configurable in config.yml. +See this example config file for more details.

wtf:
   colors:
     border:
@@ -163,6 +163,7 @@ change. 

 Values: A positive integer, 0..n.
+
diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index f9b12d27..15da8178 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -94,17 +94,17 @@
- - - Apr 15, 2018 + + + Apr 15, 2018
- 2 min read - -
+ + +
@@ -148,6 +148,7 @@ variable(s) can be found in that module’s “Required ENV Variables&rd section of the documentation. See OpsGenie for an example.

+
diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index ce83de88..28f34e6e 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -94,17 +94,17 @@
- - - Apr 17, 2018 + + + Apr 17, 2018
- 1 min read - -
+ + +
@@ -123,6 +123,7 @@ being the interface between the app and the data collection.

Widgets are defined by a required widget.go file in a Module.

+
diff --git a/docs/posts/index.html b/docs/posts/index.html index 39b6a570..a09d8472 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -95,91 +95,91 @@
  • - Attributes + Configuration: Attributes
  • - Todo + Modules: Todo
  • - Jira + Modules: Jira
  • - Google Calendar + Modules: Google Calendar
  • - Github + Modules: Github
  • - Git + Modules: Git
  • - Weather + Modules: Weather
  • - Textfile + Modules: Textfile
  • - Newrelic + Modules: New Relic
  • - Opsgenie + Modules: OpsGenie
  • - Security + Modules: Security
  • - Bamboohr + Modules: Bamboohr
  • - Clocks + Modules: Clocks diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 87d2fbbb..57469f0d 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -12,22 +12,22 @@ - Attributes + Configuration: Attributes http://wtfutil.com/posts/configuration/attributes/ Wed, 16 May 2018 21:51:23 -0700 http://wtfutil.com/posts/configuration/attributes/ - This page describes the top-level attributes that can be added to config.yml. + The following top-level attributes are configurable in config.yml. See this example config file for more details. wtf:colors:border:Focusable:"darkslateblue"focused:"orange"normal:"gray"grid:# How _wide_ the columns are, in terminal characters. In this case we have# six columns, each of which are 35 characters widecolumns:[35,35,35,35,35,35]# How _high_ the rows are, in terminal lines. In this case we have five rows# that support ten line of text, one of three lines, and one of fourrows:[10,10,10,10,10,3,4]# The app redraws itself once a secondrefreshInterval:1 Attributes colors. - Todo + Modules: Todo http://wtfutil.com/posts/modules/todo/ Thu, 10 May 2018 12:41:50 -0700 http://wtfutil.com/posts/modules/todo/ - Description An interactive todo list. + An interactive todo list. Source Code wtf/todo/ Required ENV Variables None. Keyboard Commands Key: [return] Action: Edit the selected item. Action: Close the modal item dialog and save changes. Key: [esc] Action: Remove focus from the selected item. Action: Close the modal item dialog without saving changes. Key: [space] Action: Check/uncheck the selected item. @@ -36,12 +36,12 @@ Key: j Action: Select the next item in the list. - Jira + Modules: Jira http://wtfutil.com/posts/modules/jira/ Thu, 10 May 2018 10:44:35 -0700 http://wtfutil.com/posts/modules/jira/ - Description Displays all Jira issues assigned to you for the specified project. + Displays all Jira issues assigned to you for the specified project. Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key. Keyboard Commands None. Configuration jira:colors:rows:even:"lightblue"odd:"white"domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:trueposition:top:4left:1height:1width:2project:"CORE"refreshInterval:900username:"chris.cummer" Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name. @@ -51,12 +51,12 @@ email The email address associated with your Jira account. - Google Calendar + Modules: Google Calendar http://wtfutil.com/posts/modules/gcal/ Thu, 10 May 2018 08:25:33 -0700 http://wtfutil.com/posts/modules/gcal/ - Description Displays your upcoming Google calendar events. + Displays your upcoming Google calendar events. Source Code wtf/gcal/ Required ENV Variables Key: WTF_GOOGLE_CAL_CLIENT_ID Value: Your Google API client ID. Key: WTF_GOOGLE_CAL_CLIENT_SECRET Value: Your Google API client secret. Keyboard Commands None. @@ -66,12 +66,12 @@ colors.highlights A list of arrays that define a regular expression pattern and - Github + Modules: Github http://wtfutil.com/posts/modules/github/ Wed, 09 May 2018 19:20:20 -0700 http://wtfutil.com/posts/modules/github/ - Description Displays information about git repositories hosted on Github: open review requests, and open pull requests. + Displays information about git repositories hosted on Github: open review requests, and open pull requests. Open Review Requests All open code review requests assigned to you. Open Pull Requests All open pull requests created by you. Source Code wtf/github/ Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your Github API token. @@ -81,26 +81,27 @@ Key: l Action: Show the next git repository. - Git + Modules: Git http://wtfutil.com/posts/modules/git/ Wed, 09 May 2018 14:20:48 -0700 http://wtfutil.com/posts/modules/git/ - Description Displays information about local git repositories: branch, changed files, and recent commits. + Displays information about local git repositories: branch, changed files, and recent commits. Branch The name of the currently-active git branch. Changed Files A list of all the files that have changed since the last commit, and their status. Recent Commits A list of n recent commits, who committed it, and when. Source Code wtf/git/ Required ENV Variables None. -Keyboard Commands Key: / Action: Open/close the widget’s help window. +Keyboard Commands Key: / Action: Open/close the widget’s help window. +Key: h Action: Show the previous git repository. - Weather + Modules: Weather http://wtfutil.com/posts/modules/weather/ Wed, 09 May 2018 11:44:13 -0700 http://wtfutil.com/posts/modules/weather/ - Description Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time. + Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time. Source Code wtf/weather/ Required ENV Variables Key: WTF_OWM_API_KEY Action: Your OpenWeatherMap API key. Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: h Action: Show the previous weather location. @@ -110,12 +111,12 @@ Key: → Action: Show the next weather location. - Textfile + Modules: Textfile http://wtfutil.com/posts/modules/textfile/ Wed, 09 May 2018 11:13:11 -0700 http://wtfutil.com/posts/modules/textfile/ - Description Displays the contents of the specified text file in the widget. + Displays the contents of the specified text file in the widget. Source Code wtf/textfile/ Required ENV Variables None. Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: o Action: Opens the text file in whichever text editor is associated with that file type. @@ -124,12 +125,12 @@ filePath The path to the file to be displayed in the widget. - Newrelic + Modules: New Relic http://wtfutil.com/posts/modules/newrelic/ Wed, 09 May 2018 09:01:14 -0700 http://wtfutil.com/posts/modules/newrelic/ - Description Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. + Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. Source Code wtf/newrelic/ Required ENV Variables Key: WTF_NEW_RELIC_API_KEY Value: Your New Relic API token. Keyboard Commands None. Configuration newrelic:applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n. @@ -137,12 +138,12 @@ deployCount The number of past deploys to display on screen. - Opsgenie + Modules: OpsGenie http://wtfutil.com/posts/modules/opsgenie/ Tue, 08 May 2018 20:53:40 -0700 http://wtfutil.com/posts/modules/opsgenie/ - Description Connects to the OpsGenie API and displays all your scheduled rotations and who’s currently on call. + Connects to the OpsGenie API and displays all your scheduled rotations and who’s currently on call. Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token. Keyboard Commands None. Configuration opsgenie:displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false. @@ -151,36 +152,36 @@ position Where in the grid this module’s widget will be displayed. - Security + Modules: Security http://wtfutil.com/posts/modules/security/ Tue, 08 May 2018 20:33:28 -0700 http://wtfutil.com/posts/modules/security/ - Description Displays some general information about the state of the machine’s wifi connection, firewall, and DNS settings. + Displays some general information about the state of the machine’s wifi connection, firewall, and DNS settings. Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Source Code wtf/security Required ENV Variables None. - Bamboohr + Modules: Bamboohr http://wtfutil.com/posts/modules/bamboohr/ Mon, 07 May 2018 20:17:37 -0700 http://wtfutil.com/posts/modules/bamboohr/ - Description Connects to the BambooHR API and displays who will be Away today. + Connects to the BambooHR API and displays who will be Away today. Source Code wtf/bamboohr Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token. Key: WTF_BAMBOO_HR_SUBDOMAIN Value: Your BambooHR API subdomain name. Keyboard Commands None. Configuration bamboohr:enabled:trueposition:top:0left:1height:2width:1refreshInterval:900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. -position Defines where in the grid this module’s widget will be displayed. +position Defines where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. - Clocks + Modules: Clocks http://wtfutil.com/posts/modules/clocks/ Mon, 07 May 2018 19:47:31 -0700 http://wtfutil.com/posts/modules/clocks/ - Description Displays a configurable list of world clocks, the local time, and date. + Displays a configurable list of world clocks, the local time, and date. Source Code wtf/clocks/ Required ENV Variables None. Keyboard Commands None. Configuration clocks:colors:rows:even:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name. diff --git a/docs/posts/modules/bamboohr/index.html b/docs/posts/modules/bamboohr/index.html index 172401db..d25d21ee 100644 --- a/docs/posts/modules/bamboohr/index.html +++ b/docs/posts/modules/bamboohr/index.html @@ -10,8 +10,8 @@ -Bamboohr | WTF - +Modules: Bamboohr | WTF + @@ -90,26 +90,24 @@
    -

    Bamboohr

    +

    Modules: Bamboohr

    - - - May 07, 2018 + + + May 07, 2018
    - 1 min read -     -
    + + +
    -

    Description

    -

    Connects to the BambooHR API and displays who will be Away today.

    Source Code

    @@ -149,6 +147,7 @@ How often, in seconds, this module will update its data.
    Values: Any positive integer, 0..n.

    +
    diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index 0095f306..fe57e14a 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -10,8 +10,8 @@ -Clocks | WTF - +Modules: Clocks | WTF + @@ -90,26 +90,24 @@
    -

    Clocks

    +

    Modules: Clocks

    - - - May 07, 2018 + + + May 07, 2018
    - 1 min read -     -
    + + +
    -

    Description

    -

    Displays a configurable list of world clocks, the local time, and date.

    clocks screenshot

    @@ -183,6 +181,7 @@ acending order by key, chronological will sort in asce date/time.

    +
    diff --git a/docs/posts/modules/gcal/index.html b/docs/posts/modules/gcal/index.html index da68e857..5d1b4551 100644 --- a/docs/posts/modules/gcal/index.html +++ b/docs/posts/modules/gcal/index.html @@ -10,8 +10,8 @@ -Google Calendar | WTF - +Modules: Google Calendar | WTF + @@ -90,26 +90,24 @@
    -

    Google Calendar

    +

    Modules: Google Calendar

    - - - May 10, 2018 + + + May 10, 2018
    - 2 min read -     -
    + + +
    -

    Description

    -

    Displays your upcoming Google calendar events.

    gcal screenshot

    @@ -216,6 +214,7 @@ Your Google clien Values: A string representing a file path to the JSON secret file.

    +
    diff --git a/docs/posts/modules/git/index.html b/docs/posts/modules/git/index.html index ae009bd1..3d5d3f7f 100644 --- a/docs/posts/modules/git/index.html +++ b/docs/posts/modules/git/index.html @@ -10,8 +10,8 @@ -Git | WTF - +Modules: Git | WTF + @@ -90,26 +90,24 @@
    -

    Git

    +

    Modules: Git

    - - - May 09, 2018 + + + May 09, 2018
    - 1 min read -     -
    + + +
    -

    Description

    -

    Displays information about local git repositories: branch, changed files, and recent commits.

    @@ -186,6 +184,7 @@ Defines which git repositories to watch.
    Values: A list of zero or more local file paths pointing to valid git repositories.

    +
    diff --git a/docs/posts/modules/github/index.html b/docs/posts/modules/github/index.html index df90552b..cfdf1a43 100644 --- a/docs/posts/modules/github/index.html +++ b/docs/posts/modules/github/index.html @@ -10,8 +10,8 @@ -Github | WTF - +Modules: Github | WTF + @@ -90,26 +90,24 @@
    -

    Github

    +

    Modules: Github

    - - - May 09, 2018 + + + May 09, 2018
    - 1 min read -     -
    + + +
    -

    Description

    -

    Displays information about git repositories hosted on Github: open review requests, and open pull requests.

    @@ -184,6 +182,7 @@ Your Github username. Used to figure out which review requests you’ve been added to.

    +
    diff --git a/docs/posts/modules/index.html b/docs/posts/modules/index.html index f2a4351e..4f259b2d 100644 --- a/docs/posts/modules/index.html +++ b/docs/posts/modules/index.html @@ -94,17 +94,17 @@
    - - - May 07, 2018 + + + May 07, 2018
    - 1 min read -     -
    + + +

    The heart of WTF is the modules. A module is a discreet unit of functionality that extracts data from some source and packages that data @@ -137,6 +137,7 @@ display in the “Clocks” widget.

+
diff --git a/docs/posts/modules/jira/index.html b/docs/posts/modules/jira/index.html index adc6cca7..384b8fca 100644 --- a/docs/posts/modules/jira/index.html +++ b/docs/posts/modules/jira/index.html @@ -10,8 +10,8 @@ -Jira | WTF - +Modules: Jira | WTF + @@ -90,26 +90,24 @@
-

Jira

+

Modules: Jira

- - - May 10, 2018 + + + May 10, 2018
- 1 min read - -
+ + +
-

Description

-

Displays all Jira issues assigned to you for the specified project.

jira screenshot

@@ -180,6 +178,7 @@ Values: A positive integer, 0..n.

Your Jira username.

+
diff --git a/docs/posts/modules/newrelic/index.html b/docs/posts/modules/newrelic/index.html index 40116ec6..5a5eb904 100644 --- a/docs/posts/modules/newrelic/index.html +++ b/docs/posts/modules/newrelic/index.html @@ -10,8 +10,8 @@ -Newrelic | WTF - +Modules: New Relic | WTF + @@ -90,26 +90,24 @@
-

Newrelic

+

Modules: New Relic

- - - May 09, 2018 + + + May 09, 2018
- 1 min read - -
+ + +
-

Description

-

Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it.

@@ -161,6 +159,7 @@ How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

+
diff --git a/docs/posts/modules/opsgenie/index.html b/docs/posts/modules/opsgenie/index.html index 36bbd3a0..ab5da5db 100644 --- a/docs/posts/modules/opsgenie/index.html +++ b/docs/posts/modules/opsgenie/index.html @@ -10,8 +10,8 @@ -Opsgenie | WTF - +Modules: OpsGenie | WTF + @@ -90,26 +90,24 @@
-

Opsgenie

+

Modules: OpsGenie

- - - May 08, 2018 + + + May 08, 2018
- 1 min read - -
+ + +
-

Description

-

Connects to the OpsGenie API and displays all your scheduled rotations and who’s currently on call.

@@ -155,6 +153,7 @@ How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

+
diff --git a/docs/posts/modules/security/index.html b/docs/posts/modules/security/index.html index 10913623..6bb540b6 100644 --- a/docs/posts/modules/security/index.html +++ b/docs/posts/modules/security/index.html @@ -10,8 +10,8 @@ -Security | WTF - +Modules: Security | WTF + @@ -90,26 +90,24 @@
-

Security

+

Modules: Security

- - - May 08, 2018 + + + May 08, 2018
- 1 min read - -
+ + +
-

Description

-

Displays some general information about the state of the machine’s wifi connection, firewall, and DNS settings.

@@ -168,6 +166,7 @@ How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

+
diff --git a/docs/posts/modules/textfile/index.html b/docs/posts/modules/textfile/index.html index d135753b..d4a69af1 100644 --- a/docs/posts/modules/textfile/index.html +++ b/docs/posts/modules/textfile/index.html @@ -10,8 +10,8 @@ -Textfile | WTF - +Modules: Textfile | WTF + @@ -90,26 +90,24 @@
-

Textfile

+

Modules: Textfile

- - - May 09, 2018 + + + May 09, 2018
- 1 min read - -
+ + +
-

Description

-

Displays the contents of the specified text file in the widget.

textfile screenshot

@@ -155,6 +153,7 @@ How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

+
diff --git a/docs/posts/modules/todo/index.html b/docs/posts/modules/todo/index.html index d0d56d82..e1ac147d 100644 --- a/docs/posts/modules/todo/index.html +++ b/docs/posts/modules/todo/index.html @@ -10,8 +10,8 @@ -Todo | WTF - +Modules: Todo | WTF + @@ -90,26 +90,24 @@
-

Todo

+

Modules: Todo

- - - May 10, 2018 + + + May 10, 2018
- 2 min read - -
+ + +
-

Description

-

An interactive todo list.

todo screenshot

@@ -213,6 +211,7 @@ How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

+
diff --git a/docs/posts/modules/weather/index.html b/docs/posts/modules/weather/index.html index 7302501a..876aa6b1 100644 --- a/docs/posts/modules/weather/index.html +++ b/docs/posts/modules/weather/index.html @@ -10,8 +10,8 @@ -Weather | WTF - +Modules: Weather | WTF + @@ -90,26 +90,24 @@
-

Weather

+

Modules: Weather

- - - May 09, 2018 + + + May 09, 2018
- 1 min read - -
+ + +
-

Description

-

Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time.

@@ -191,6 +189,7 @@ The temperature scale in which to display temperature values.
Values: F for Fahrenheit, C for Celcius.

+
diff --git a/wtf.go b/wtf.go index 5494d462..8d8441f5 100644 --- a/wtf.go +++ b/wtf.go @@ -2,7 +2,6 @@ package main import ( "flag" - //"fmt" "os" "time"