From 3e27166858f3d0bb28d59a471d67c11997e826fa Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Sun, 10 Jun 2018 18:36:42 -0400 Subject: [PATCH] Add basic documentation for Google Spreadsheet module --- _site/content/posts/modules/gcal.md | 6 +- _site/content/posts/modules/gspreadsheets.md | 70 +++++++ _site/content/posts/modules/jira.md | 29 ++- docs/index.xml | 29 ++- docs/posts/index.html | 7 + docs/posts/index.xml | 29 ++- docs/posts/modules/gcal/index.html | 6 +- docs/posts/modules/gspreadsheets/index.html | 184 +++++++++++++++++++ docs/posts/modules/jira/index.html | 25 ++- docs/sitemap.xml | 9 +- 10 files changed, 364 insertions(+), 30 deletions(-) create mode 100644 _site/content/posts/modules/gspreadsheets.md create mode 100644 docs/posts/modules/gspreadsheets/index.html diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md index ef6a70dd..03593431 100644 --- a/_site/content/posts/modules/gcal.md +++ b/_site/content/posts/modules/gcal.md @@ -19,11 +19,7 @@ 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. +None. ## Keyboard Commands diff --git a/_site/content/posts/modules/gspreadsheets.md b/_site/content/posts/modules/gspreadsheets.md new file mode 100644 index 00000000..77d8a93c --- /dev/null +++ b/_site/content/posts/modules/gspreadsheets.md @@ -0,0 +1,70 @@ +--- +title: "Google Spreadsheets" +date: 2018-06-10T18:26:26-04:00 +draft: false +--- + +Added in `v0.0.7`. + +Display information + +```bash +wtf/gspreadsheets/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +gspreadsheets: + colors: + values: "green" + cells: + names: + - "Cell 1 name" + - "Cell 2 name" + addresses: + - "A1" + - "A2" + enabled: true + position: + top: 0 + left: 0 + width: 1 + height: 1 + refreshInterval: "300" + secretFile: "~/.wtf/gspreadsheets/client_secret.json" + sheetId: "id_of_google_spreadsheet" +``` + +### Attributes + +`colors.values`
+The color to display the cell values in.
+Values: Any X11 color name. + +`cells.names`
+ +`cells.addresses`
+ +`enabled`
+Whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+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 index 08479c62..a25cc1f3 100644 --- a/_site/content/posts/modules/jira.md +++ b/_site/content/posts/modules/jira.md @@ -25,6 +25,8 @@ None. ## Configuration +### Single Jira Project + ```yaml jira: colors: @@ -40,7 +42,32 @@ jira: left: 1 height: 1 width: 2 - project: "JIRA" + project: "ProjectA" + refreshInterval: 900 + username: "chris.cummer" +``` + +### Multiple Jira Projects + +If you want to monitor multiple Jira projects, use the following +configuration (note the difference in `project`): + +```yaml +jira: + colors: + rows: + even: "lightblue" + odd: "white" + domain: "https://umbrellacorp.atlassian.net" + email: "chriscummer@me.com" + enabled: true + jql: "issueType = Story" + position: + top: 4 + left: 1 + height: 1 + width: 2 + project: ["ProjectA", "ProjectB"] refreshInterval: 900 username: "chris.cummer" ``` diff --git a/docs/index.xml b/docs/index.xml index 28d48bd1..288b8b9e 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,26 @@ Recent content on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Mon, 04 Jun 2018 20:06:40 -0700 + Sun, 10 Jun 2018 18:26:26 -0400 + + Google Spreadsheets + https://wtfutil.com/posts/modules/gspreadsheets/ + Sun, 10 Jun 2018 18:26:26 -0400 + + https://wtfutil.com/posts/modules/gspreadsheets/ + Added in v0.0.7. +Display information +wtf/gspreadsheets/ Required ENV Variables None. +Keyboard Commands None. +Configuration gspreadsheets:colors:values:"green"cells:names:-"Cell 1 name"-"Cell 2 name"addresses:-"A1"-"A2"enabled:trueposition:top:0left:0width:1height:1refreshInterval:"300"secretFile:"~/.wtf/gspreadsheets/client_secret.json"sheetId:"id_of_google_spreadsheet" Attributes colors.values The color to display the cell values in. Values: Any X11 color name. +cells.names cells.addresses enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. + + Bittrex https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/ @@ -174,10 +189,8 @@ Key: j Action: Select the next item in the list. 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:truejql:"issueType = Story"position:top:4left:1height:1width:2project:"JIRA"refreshInterval:900username:"chris.cummer" Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name. -colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name. -domain Your Jira corporate domain. Values: A valid URI. -email The email address associated with your Jira account. +Configuration Single Jira Project jira:colors:rows:even:"lightblue"odd:"white"domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:truejql:"issueType = Story"position:top:4left:1height:1width:2project:"ProjectA"refreshInterval:900username:"chris.cummer" Multiple Jira Projects If you want to monitor multiple Jira projects, use the following configuration (note the difference in project): +jira:colors:rows:even:"lightblue"odd:"white"domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:truejql:"issueType = Story"position:top:4left:1height:1width:2project:["ProjectA","ProjectB"]refreshInterval:900username:"chris.cummer" Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name. @@ -188,9 +201,9 @@ email The email address associated with your Jira account. https://wtfutil.com/posts/modules/gcal/ Displays your upcoming Google calendar events. Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google’s Go Quickstart first and if you have problems, then take a look at this comment by WesleydeSouza which offers a slightly different approach. -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. +Source Code wtf/gcal/ Required ENV Variables None. +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:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json"withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. diff --git a/docs/posts/index.html b/docs/posts/index.html index 120d52e0..09edccfc 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -99,6 +99,13 @@

Posts

  • + + Google Spreadsheets + + + + +
  • Bittrex diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 71eef75b..62da9b8d 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -6,11 +6,26 @@ Recent content in Posts on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Mon, 04 Jun 2018 20:06:40 -0700 + Sun, 10 Jun 2018 18:26:26 -0400 + + Google Spreadsheets + https://wtfutil.com/posts/modules/gspreadsheets/ + Sun, 10 Jun 2018 18:26:26 -0400 + + https://wtfutil.com/posts/modules/gspreadsheets/ + Added in v0.0.7. +Display information +wtf/gspreadsheets/ Required ENV Variables None. +Keyboard Commands None. +Configuration gspreadsheets:colors:values:"green"cells:names:-"Cell 1 name"-"Cell 2 name"addresses:-"A1"-"A2"enabled:trueposition:top:0left:0width:1height:1refreshInterval:"300"secretFile:"~/.wtf/gspreadsheets/client_secret.json"sheetId:"id_of_google_spreadsheet" Attributes colors.values The color to display the cell values in. Values: Any X11 color name. +cells.names cells.addresses enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. + + Bittrex https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/ @@ -174,10 +189,8 @@ Key: j Action: Select the next item in the list. 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:truejql:"issueType = Story"position:top:4left:1height:1width:2project:"JIRA"refreshInterval:900username:"chris.cummer" Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name. -colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name. -domain Your Jira corporate domain. Values: A valid URI. -email The email address associated with your Jira account. +Configuration Single Jira Project jira:colors:rows:even:"lightblue"odd:"white"domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:truejql:"issueType = Story"position:top:4left:1height:1width:2project:"ProjectA"refreshInterval:900username:"chris.cummer" Multiple Jira Projects If you want to monitor multiple Jira projects, use the following configuration (note the difference in project): +jira:colors:rows:even:"lightblue"odd:"white"domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:truejql:"issueType = Story"position:top:4left:1height:1width:2project:["ProjectA","ProjectB"]refreshInterval:900username:"chris.cummer" Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name. @@ -188,9 +201,9 @@ email The email address associated with your Jira account. https://wtfutil.com/posts/modules/gcal/ Displays your upcoming Google calendar events. Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google’s Go Quickstart first and if you have problems, then take a look at this comment by WesleydeSouza which offers a slightly different approach. -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. +Source Code wtf/gcal/ Required ENV Variables None. +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:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json"withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. diff --git a/docs/posts/modules/gcal/index.html b/docs/posts/modules/gcal/index.html index fa6de93d..79d7ae93 100644 --- a/docs/posts/modules/gcal/index.html +++ b/docs/posts/modules/gcal/index.html @@ -124,11 +124,7 @@ first and if you have problems, then take a look at this 
    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.

    +

    None.

    Keyboard Commands

    diff --git a/docs/posts/modules/gspreadsheets/index.html b/docs/posts/modules/gspreadsheets/index.html new file mode 100644 index 00000000..16f16696 --- /dev/null +++ b/docs/posts/modules/gspreadsheets/index.html @@ -0,0 +1,184 @@ + + + + + + + + + + + + +Google Spreadsheets | WTF - A Terminal Dashboard + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + WFT Logo +

    + +

    +
    + + + +

    + © 2018 Chris Cummer. +
    + Some Rights Reserved. + +

    +
    +
    + +
    +
    +

    Google Spreadsheets

    + +
    + + + + Jun 10, 2018 + + + + +
    + +     +
    + + + +

    Added in v0.0.7.

    + +

    Display information

    +
    wtf/gspreadsheets/
    +

    Required ENV Variables

    + +

    None.

    + +

    Keyboard Commands

    + +

    None.

    + +

    Configuration

    +
    gspreadsheets:
+  colors:
+    values: "green"
+  cells:
+    names:
+    - "Cell 1 name"
+    - "Cell 2 name"
+    addresses:
+    - "A1"
+    - "A2"
+  enabled: true
+  position:
+    top: 0
+    left: 0
+    width: 1
+    height: 1
+  refreshInterval: "300"
+  secretFile: "~/.wtf/gspreadsheets/client_secret.json"
+  sheetId: "id_of_google_spreadsheet"
    +

    Attributes

    + +

    colors.values
    +The color to display the cell values in.
    +Values: Any X11 color name.

    + +

    cells.names

    + +

    cells.addresses

    + +

    enabled
    +Whether or not this module is executed and if its data displayed onscreen.
    +Values: true, false.

    + +

    position
    +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/docs/posts/modules/jira/index.html b/docs/posts/modules/jira/index.html index 258cb919..21d14850 100644 --- a/docs/posts/modules/jira/index.html +++ b/docs/posts/modules/jira/index.html @@ -129,6 +129,8 @@

    None.

    Configuration

    + +

    Single Jira Project

    jira:
   colors:
     rows:
@@ -143,7 +145,28 @@
     left: 1
     height: 1
     width: 2
-  project: "JIRA"
+  project: "ProjectA"
+  refreshInterval: 900
+  username: "chris.cummer"
    +

    Multiple Jira Projects

    + +

    If you want to monitor multiple Jira projects, use the following +configuration (note the difference in project):

    +
    jira:
+  colors:
+    rows:
+      even: "lightblue"
+      odd: "white"
+  domain: "https://umbrellacorp.atlassian.net"
+  email: "chriscummer@me.com"
+  enabled: true
+  jql: "issueType = Story"
+  position:
+    top: 4
+    left: 1
+    height: 1
+    width: 2
+  project: ["ProjectA", "ProjectB"]
   refreshInterval: 900
   username: "chris.cummer"

    Attributes

    diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 64670468..e7166e26 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,6 +2,11 @@ + + https://wtfutil.com/posts/modules/gspreadsheets/ + 2018-06-10T18:26:26-04:00 + + https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/ 2018-06-04T20:06:40-07:00 @@ -134,7 +139,7 @@ https://wtfutil.com/posts/ - 2018-06-04T20:06:40-07:00 + 2018-06-10T18:26:26-04:00 0 @@ -145,7 +150,7 @@ https://wtfutil.com/ - 2018-06-04T20:06:40-07:00 + 2018-06-10T18:26:26-04:00 0