diff --git a/_site/content/posts/modules.md b/_site/content/posts/modules.md index 6a198596..3e1fcb8f 100644 --- a/_site/content/posts/modules.md +++ b/_site/content/posts/modules.md @@ -24,8 +24,8 @@ Available modules:
  • Clocks
  • Git
  • Github -
  • Google Calendar -
  • Jira +
  • Google Calendar +
  • Jira
  • New Relic
  • OpsGenie
  • Security diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md new file mode 100644 index 00000000..f53718a7 --- /dev/null +++ b/_site/content/posts/modules/gcal.md @@ -0,0 +1,106 @@ +--- +title: "Google Calendar" +date: 2018-05-10T08:25:33-07:00 +draft: false +--- + +## Description + +Displays your upcoming Google calendar events. + +gcal screenshot + +## Source Code + +```bash +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. + +## Configuration + +```yaml +gcal: + colors: + title: "red" + description: "lightblue" + highlights: + - ['1on1|1\/11', 'green'] + - ['apple|google|aws', 'blue'] + - ['interview|meet', 'magenta'] + - ['lunch', 'yellow'] + past: "gray" + conflictIcon: "🚨" + currentIcon: "💥" + enabled: true + eventCount: 12 + position: + top: 0 + left: 0 + height: 4 + width: 1 + refreshInterval: 300 + secretFile: "~/.wtf/gcal/client_secret.json" +``` + +### Attributes + +`colors.title`
    +Specifies the default colour for calendar event titles.
    +Values: Any X11 +color name. + +`colors.description`
    +Specifies the default color for calendar event descriptions.
    +Values: Any X11 +color name. + +`colors.highlights`
    +A list of arrays that define a regular expression pattern and a color. +If a calendar event title matches a regular expression, the title will +be drawn in that colour. Over-rides the default title colour.
    +Values: [a valid regular expression, any X11 color name.] + +`colors.past`
    +Specifies the color for calendar events that have passed.
    +Values: Any X11 +color name. + +`conflictIcon`
    +The icon displayed beside calendar events that have conflicting times +(they intersect or overlap in some way).
    +Values: Any displayable unicode character. + +`currentIcon`
    +The icon displayed beside the current calendar event.
    +Values: Any displayable unicode character. + +`enabled`
    +Determines whether or not this module is executed and if its data displayed onscreen.
    +Values: `true`, `false`. + +`eventCount`
    +The number of calendar events to display.
    +Values: A positive integer, `0..n`. + +`position`
    +Defines where in the grid this module's widget will be displayed.
    + +`refreshInterval`
    +How often, in seconds, this module will update its data.
    +Values: A positive integer, `0..n`. + +`secretFile`
    +Your Google client secret JSON file.
    +Values: A string representing a file path to the JSON secret file. diff --git a/_site/content/posts/modules/jira.md b/_site/content/posts/modules/jira.md new file mode 100644 index 00000000..013d1b1a --- /dev/null +++ b/_site/content/posts/modules/jira.md @@ -0,0 +1,64 @@ +--- +title: "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 + +## Source Code + +```bash +wtf/jira/ +``` + +## Required ENV Variables + +Key: `WTF_JIRA_API_KEY`
    +Value: Your Jira API key. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +jira: + domain: "https://umbrellacorp.atlassian.net" + email: "chriscummer@me.com" + enabled: true + position: + top: 4 + left: 1 + height: 1 + width: 2 + project: "CORE" + refreshInterval: 900 + username: "chris.cummer" +``` + +### Attributes + +`domain`
    + +`email`
    + +`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.
    + +`project`
    + +`refreshInterval`
    +How often, in seconds, this module will update its data.
    +Values: A positive integer, `0..n`. + +`username`
    diff --git a/_site/static/imgs/modules/gcal.png b/_site/static/imgs/modules/gcal.png new file mode 100644 index 00000000..95cf62fb Binary files /dev/null and b/_site/static/imgs/modules/gcal.png differ diff --git a/_site/static/imgs/modules/jira.png b/_site/static/imgs/modules/jira.png new file mode 100644 index 00000000..8f80afee Binary files /dev/null and b/_site/static/imgs/modules/jira.png differ diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index bad78844..f89dfb08 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -23,8 +23,8 @@
  • Clocks
  • Git
  • Github
    • -
  • Google Calendar
    • -
  • Jira
    • +
  • Google Calendar
    • +
  • Jira
  • New Relic
  • OpsGenie
  • Security
    • diff --git a/docs/404.html b/docs/404.html index 9782fe0c..689062d6 100644 --- a/docs/404.html +++ b/docs/404.html @@ -64,8 +64,8 @@
  • Clocks
  • Git
  • Github
    • -
  • Google Calendar
    • -
  • Jira
    • +
  • Google Calendar
    • +
  • Jira
  • New Relic
  • OpsGenie
  • Security
    • diff --git a/docs/categories/index.html b/docs/categories/index.html index b61bf45f..9cfefd5f 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -66,8 +66,8 @@
  • Clocks
  • Git
  • Github
    • -
  • Google Calendar
    • -
  • Jira
    • +
  • Google Calendar
    • +
  • Jira
  • New Relic
  • OpsGenie
  • Security
    • diff --git a/docs/imgs/modules/gcal.png b/docs/imgs/modules/gcal.png new file mode 100644 index 00000000..95cf62fb Binary files /dev/null and b/docs/imgs/modules/gcal.png differ diff --git a/docs/imgs/modules/jira.png b/docs/imgs/modules/jira.png new file mode 100644 index 00000000..8f80afee Binary files /dev/null and b/docs/imgs/modules/jira.png differ diff --git a/docs/index.html b/docs/index.html index 3047c0ec..8dae1a5c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -65,8 +65,8 @@
  • Clocks
  • Git
  • Github
    • -
  • Google Calendar
    • -
  • Jira
    • +
  • Google Calendar
    • +
  • Jira
  • New Relic
  • OpsGenie
  • Security
    • diff --git a/docs/index.xml b/docs/index.xml index c8abd273..7965dbd7 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,39 @@ Recent content on WTF Hugo -- gohugo.io en-us - Wed, 09 May 2018 19:20:20 -0700 + Thu, 10 May 2018 10:44:35 -0700 + + 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. +Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key. +Keyboard Commands None. +Configuration jira:domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:trueposition:top:4left:1height:1width:2project:"CORE"refreshInterval:900username:"chris.cummer" Attributes domain email 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. project refreshInterval How often, in seconds, this module will update its data. + + + + 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. +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. +Configuration gcal:colors:title:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json" Attributes colors.title Specifies the default colour for calendar event titles. Values: Any X11 color name. +colors.description Specifies the default color for calendar event descriptions. Values: Any X11 color name. +colors.highlights A list of arrays that define a regular expression pattern and a color. + + Github http://wtfutil.com/posts/modules/github/ diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index bc3abd0d..d00db5e6 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -64,8 +64,8 @@
  • Clocks
  • Git
  • Github
    • -
  • Google Calendar
    • -
  • Jira
    • +
  • Google Calendar
    • +
  • Jira
  • New Relic
  • OpsGenie
  • Security
    • diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index ab943c21..7ecea40d 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -64,8 +64,8 @@
  • Clocks
  • Git
  • Github
    • -
  • Google Calendar
    • -
  • Jira
    • +
  • Google Calendar
    • +
  • Jira
  • New Relic
  • OpsGenie
  • Security
    • diff --git a/docs/posts/index.html b/docs/posts/index.html index de553307..50f0541c 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -66,8 +66,8 @@
  • Clocks
  • Git
  • Github
    • -
  • Google Calendar
    • -
  • Jira
    • +
  • Google Calendar
    • +
  • Jira
  • New Relic
  • OpsGenie
  • Security
    • @@ -92,6 +92,20 @@

    Posts