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

Clean up the Zendesk module's API credentials loading

This commit is contained in:
Chris Cummer
2018-07-31 15:34:42 -07:00
parent 2fe8164e20
commit b6036a3eae
6 changed files with 58 additions and 34 deletions

View File

@@ -14,15 +14,6 @@ Displays all Trello cards on specified lists.
wtf/trello/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_TRELLO_APP_KEY` <br />
<span class="caption">Value:</span> Your Trello App Key. <br />
<span class="caption">Key:</span> `WTF_TRELLO_ACCESS_TOKEN` <br />
<span class="caption">Value:</span> Your Trello Access Token. <br />
_You can get your API key at: trello.com/app-key._
## Keyboard Commands
None.
@@ -32,11 +23,13 @@ None.
### Single Trello List
```yaml
trello:
trello:
accessToken: "7b8b14f8743a408a93276d7155dd9ee2"
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
board: Main
enabled: true
list: "Todo"
position:
position:
height: 1
left: 2
top: 0
@@ -51,11 +44,13 @@ If you want to monitor multiple Trello lists, use the following
configuration (note the difference in `list`):
```yaml
trello:
trello:
accessToken: "7b8b14f8743a408a93276d7155dd9ee2"
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
board: Main
enabled: true
list: ["Todo", "Done"]
position:
position:
height: 1
left: 2
top: 0
@@ -66,6 +61,12 @@ trello:
### Attributes
`accessToken` <br />
Value: Your Trello access token.
`apiKey` <br />
Value: Your Trello API key.
`board` <br />
The name of the Trello board. <br />

View File

@@ -14,14 +14,6 @@ Displays tickets in the "New" status - i.e. have not yet been assigned.
wtf/zendesk/
```
## Required ENV Variables
<span class="caption">Key:</span> `ZENDESK_API` <br />
<span class="caption">Value:</span> Your Zendesk API Token
<span class="caption">Key:</span> `ZENDESK_DOMAIN` <br />
<span class="caption">Value:</span> Your Zendesk subdomain
## Keyboard Commands
<span class="caption">Key:</span> `[return]` <br />
@@ -43,6 +35,7 @@ wtf/zendesk/
```yaml
zendesk:
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
enabled: true
position:
top: 0
@@ -50,11 +43,15 @@ zendesk:
height: 1
width: 1
status: "new"
subdomain: "your_domain"
username: "your_email@acme.com"
```
### Attributes
`apiKey` <br />
Value: Your Zendesk API token.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
@@ -66,6 +63,9 @@ Defines where in the grid this module's widget will be displayed. <br />
The status of tickets you want to retrieve.
Values: `new`, `open`, `pending`, `hold`.
`subdomain` <br />
Value: Your Zendesk subdomain.
`username` <br />
Your Zendesk username
Values: A valid Zendesk username (usually an email address).