1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Add basic documentation for Google Spreadsheet module

This commit is contained in:
Chris Cummer
2018-06-10 18:36:42 -04:00
parent 78fd0ca40b
commit 3e27166858
10 changed files with 364 additions and 30 deletions

View File

@@ -19,11 +19,7 @@ wtf/gcal/
## Required ENV Variables
<span class="caption">Key:</span> `WTF_GOOGLE_CAL_CLIENT_ID` <br />
<span class="caption">Value:</span> Your <a href="https://developers.google.com/calendar/auth">Google API</a> client ID.
<span class="caption">Key:</span> `WTF_GOOGLE_CAL_CLIENT_SECRET` <br />
<span class="caption">Value:</span> Your <a href="https://developers.google.com/calendar/auth">Google API</a> client secret.
None.
## Keyboard Commands

View File

@@ -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` <br />
The color to display the cell values in. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
`cells.names` <br />
`cells.addresses` <br />
`enabled` <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`position` <br />
Where in the grid this module's widget will be displayed. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0..n`.
`secretFile` <br />
Your <a href="https://developers.google.com/sheets/api/quickstart/go">Google client secret</a> JSON file. <br />
Values: A string representing a file path to the JSON secret file.

View File

@@ -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"
```