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

Updated documentation for zendesk module

This commit is contained in:
Tim Fitzgerald 2018-07-25 15:04:53 -07:00
parent d5056bc3fc
commit 933ec33cf0

View File

@ -20,12 +20,30 @@ wtf/zendesk/
<span class="caption">Key:</span> `ZENDESK_DOMAIN` <br /> <span class="caption">Key:</span> `ZENDESK_DOMAIN` <br />
<span class="caption">Value:</span> Your Zendesk subdomain <span class="caption">Value:</span> Your Zendesk subdomain
## Keyboard Commands
<span class="caption">Key:</span> `[return]` <br />
<span class="caption">Action:</span> Open the selected ticket in the browser.
<span class="caption">Key:</span> `j` <br />
<span class="caption">Action:</span> Select the next item in the list.
<span class="caption">Key:</span> `k` <br />
<span class="caption">Action:</span> Select the previous item in the list.
<span class="caption">Key:</span> `↓` <br />
<span class="caption">Action:</span> Scroll down the list.
<span class="caption">Key:</span> `↑` <br />
<span class="caption">Action:</span> Scroll up the list.
## Configuration ## Configuration
```yaml ```yaml
zendesk: zendesk:
enabled: true enabled: true
username: "your_email@acme.com" username: "your_email@acme.com"
status: "new"
position: position:
top: 0 top: 0
left: 2 left: 2
@ -38,3 +56,7 @@ zendesk:
`username` <br /> `username` <br />
Your Zendesk username Your Zendesk username
Values: A valid Zendesk username (usually an email address). Values: A valid Zendesk username (usually an email address).
`status` <br />
The status of tickets you want to retrieve.
Values: `new`, `open`, `pending`, `hold`.