taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Add new documentation for config API key modules

Browse Source
This commit is contained in:
Chris Cummer
2018-07-31 14:48:26 -07:00
parent 9059b73c51
commit ebad879e0a
14 changed files with 129 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
_site/content/posts/modules/bamboohr.md
View File

@@ -12,14 +12,6 @@ Connects to the BambooHR API and displays who will be Away today.
wtf/bamboohr/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_BAMBOO_HR_TOKEN` <br />
<span class="caption">Value:</span> Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.
<span class="caption">Key:</span> `WTF_BAMBOO_HR_SUBDOMAIN` <br />
<span class="caption">Value:</span> Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.
## Keyboard Commands
None.
@@ -28,6 +20,7 @@ None.
```yaml
bamboohr:
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
enabled: true
position:
top: 0
@@ -35,12 +28,16 @@ bamboohr:
height: 2
width: 1
refreshInterval: 900
subdomain: "testco"
```
### Attributes
`apiKey` <br />
Value: Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`position` <br />
@@ -49,3 +46,6 @@ 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: Any positive integer, `0..n`.
`subdomain` <br />
Value: Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.

32
_site/content/posts/modules/github.md
View File

@@ -23,22 +23,6 @@ All open pull requests created by you.
wtf/github/
```
## GitHub Required ENV Variables
<span class="caption">Key:</span> `WTF_GITHUB_TOKEN` <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">GitHub API</a> token.
## GitHub Enterprise Required ENV Variables
<span class="caption">Key:</span> `WTF_GITHUB_TOKEN` <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">GitHub API</a> token.
<span class="caption">Key:</span> `WTF_GITHUB_BASE_URL` <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> API URL.
<span class="caption">Key:</span> `WTF_GITHUB_UPLOAD_URL` <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> upload URL (often the same as API URL).
## Keyboard Commands
<span class="caption">Key:</span> `/` <br />
@@ -60,6 +44,8 @@ wtf/github/
```yaml
github:
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
baseURL: ""
enabled: true
enableStatus: true
position:
@@ -71,13 +57,21 @@ github:
repositories:
wesker-api: "UmbrellaCorp"
wtf: "senorprogrammer"
uploadURL: ""
username: "senorprogrammer"
```
### Attributes
`apiKey` <br />
Value: Your <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">GitHub API</a> token.
`baseURL` <br />
_Optional_ <br />
Value: Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> API URL.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`enableStatus` <br />
@@ -98,6 +92,10 @@ for. <br />
<span class="caption">Key:</span> The name of the repository. <br />
<span class="caption">Value:</span> The name of the account or organization that owns the repository.
`uploadURL` <br />
_Optional_ <br />
Value: Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> upload URL (often the same as API URL).
`username` <br />
Your GitHub username. Used to figure out which review requests you've
been added to.

10
_site/content/posts/modules/jira.md
View File

@@ -14,11 +14,6 @@ Displays all Jira issues assigned to you for the specified project.
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
<span class="caption">Key:</span> `[return]` <br />
@@ -42,6 +37,7 @@ wtf/jira/
```yaml
jira:
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
colors:
rows:
even: "lightblue"
@@ -68,6 +64,7 @@ configuration (note the difference in `project`):
```yaml
jira:
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
colors:
rows:
even: "lightblue"
@@ -89,6 +86,9 @@ jira:
### Attributes
`apiKey` <br />
Value: Your <a href="https://confluence.atlassian.com/cloud/api-tokens-938839638.html">Jira API</a> key.
`colors.rows.even` <br />
Define the foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11

10
_site/content/posts/modules/newrelic.md
View File

@@ -15,12 +15,6 @@ monitored application: deploy ID, deploy time, and who deployed it.
wtf/newrelic/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_NEW_RELIC_API_KEY` <br />
<span class="caption">Value:</span> Your <a href="">New Relic API</a>
token.
## Keyboard Commands
None.
@@ -29,6 +23,7 @@ None.
```yaml
newrelic:
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
applicationId: 10549735
deployCount: 6
enabled: true
@@ -42,6 +37,9 @@ newrelic:
### Attributes
`apiKey` <br />
Value: Your <a href="https://docs.newrelic.com/docs/apis/getting-started/intro-apis/access-rest-api-keys">New Relic API</a> token.
`applicationId` <br />
The integer ID of the New Relic application you wish to report on. <br
/>

10
_site/content/posts/modules/opsgenie.md
View File

@@ -15,12 +15,6 @@ and who's currently on call.
wtf/opsgenie/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_OPS_GENIE_API_KEY` <br />
<span class="caption">Value:</span> Your <a href="https://docs.opsgenie.com/docs/api-integration">OpsGenie
API</a> token.
## Keyboard Commands
None.
@@ -29,6 +23,7 @@ None.
```yaml
opsgenie:
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
displayEmpty: false
enabled: true
position:
@@ -41,6 +36,9 @@ opsgenie:
### Attributes
`apiKey` < br />
Value: Your <a href="https://docs.opsgenie.com/docs/api-integration">OpsGenie API</a> token.
`displayEmpty` <br />
Whether schedules with no assigned person on-call should be displayed. <br />
Values: `true`, `false`.

11
_site/content/posts/modules/todoist.md
View File

@@ -16,13 +16,6 @@ Displays all items on specified project.
wtf/todoist/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_TODOIST_TOKEN` <br />
<span class="caption">Value:</span> Your Todoist API Token. <br />
_You can get your API Token at: todoist.com/prefs/integrations._
## Keyboard Commands
<span class="caption">Key:</span> `h` <br />
@@ -62,6 +55,7 @@ _You can get your API Token at: todoist.com/prefs/integrations._
```yaml
todoist:
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
enabled: true
position:
top: 0
@@ -75,6 +69,9 @@ todoist:
### Attributes
`apiKey` <br />
Value: Your <a href="https://developer.todoist.com/sync/v7/">Todoist API</a> token.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.