mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Adds the Gcal and Jira modules to the documentation
This commit is contained in:
Chris Cummer
106
_site/content/posts/modules/gcal.md
Normal file
106
_site/content/posts/modules/gcal.md
Normal file
@@ -0,0 +1,106 @@
|
||||
---
|
||||
title: "Google Calendar"
|
||||
date: 2018-05-10T08:25:33-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Displays your upcoming Google calendar events.
|
||||
|
||||
<img src="/imgs/modules/gcal.png" width="320" height="389" alt="gcal screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
||||
## 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` <br />
|
||||
Specifies the default colour for calendar event titles. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color</a> name.
|
||||
|
||||
`colors.description` <br />
|
||||
Specifies the default color for calendar event descriptions. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color</a> name.
|
||||
|
||||
`colors.highlights` <br />
|
||||
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. <br />
|
||||
Values: [a valid regular expression, any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.]
|
||||
|
||||
`colors.past` <br />
|
||||
Specifies the color for calendar events that have passed. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color</a> name.
|
||||
|
||||
`conflictIcon` <br />
|
||||
The icon displayed beside calendar events that have conflicting times
|
||||
(they intersect or overlap in some way). <br />
|
||||
Values: Any displayable unicode character.
|
||||
|
||||
`currentIcon` <br />
|
||||
The icon displayed beside the current calendar event. <br />
|
||||
Values: Any displayable unicode character.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`eventCount` <br />
|
||||
The number of calendar events to display. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`position` <br />
|
||||
Defines 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/calendar/quickstart/go">Google client secret</a> JSON file. <br />
|
||||
Values: A string representing a file path to the JSON secret file.
|
||||
64
_site/content/posts/modules/jira.md
Normal file
64
_site/content/posts/modules/jira.md
Normal file
@@ -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.
|
||||
|
||||
<img src="/imgs/modules/jira.png" width="640" height="188" alt="jira screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/jira/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
<span class="caption">Key:</span> `WTF_JIRA_API_KEY` <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://confluence.atlassian.com/cloud/api-tokens-938839638.html">Jira API</a> 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` <br />
|
||||
|
||||
`email` <br />
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`project` <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`username` <br />
|
||||
Reference in New Issue
Block a user