mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Adds the Github module to the documentation
This commit is contained in:
@@ -23,7 +23,7 @@ Available modules:
|
||||
<li><a href="/posts/modules/bamboohr">BambooHR</a>
|
||||
<li><a href="/posts/modules/clocks">Clocks</a>
|
||||
<li><a href="/posts/modules/git">Git</a>
|
||||
<li><a href="/posts/modules/github" class="disabled">Github</a>
|
||||
<li><a href="/posts/modules/github">Github</a>
|
||||
<li><a href="/posts/modules/gcal" class="disabled">Google Calendar</a>
|
||||
<li><a href="/posts/modules/jira" class="disabled">Jira</a>
|
||||
<li><a href="/posts/modules/newrelic">New Relic</a>
|
||||
|
||||
@@ -74,7 +74,6 @@ git:
|
||||
The number of past commits to display. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
88
_site/content/posts/modules/github.md
Normal file
88
_site/content/posts/modules/github.md
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: "Github"
|
||||
date: 2018-05-09T19:20:20-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Displays information about git repositories hosted on Github: open
|
||||
review requests, and open pull requests.
|
||||
|
||||
<img src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
|
||||
|
||||
#### Open Review Requests
|
||||
|
||||
Displays all open code review requests assigned to you.
|
||||
|
||||
#### Open Pull Requests
|
||||
|
||||
Displays all open pull requests created by you.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/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.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
<span class="caption">Action:</span> Open/close the widget's help window.
|
||||
|
||||
<span class="caption">Key:</span> `h` <br />
|
||||
<span class="caption">Action:</span> Show the previous git repository.
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span> Show the next git repository.
|
||||
|
||||
<span class="caption">Key:</span> `←` <br />
|
||||
<span class="caption">Action:</span> Show the previous git repository.
|
||||
|
||||
<span class="caption">Key:</span> `→` <br />
|
||||
<span class="caption">Action:</span> Show the next git repository.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
github:
|
||||
enabled: true
|
||||
position:
|
||||
top: 2
|
||||
left: 3
|
||||
height: 2
|
||||
width: 2
|
||||
refreshInterval: 300
|
||||
repositories:
|
||||
wesker-api: "UmbrellaCorp"
|
||||
wtf: "senorprogrammer"
|
||||
username: "senorprogrammer"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`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 />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`repositories` <br />
|
||||
A list of key/value pairs each describing a Github repository to fetch data
|
||||
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.
|
||||
|
||||
`username` <br />
|
||||
Your Github username. Used to figure out which review requests you've
|
||||
been added to.
|
||||
BIN
_site/static/imgs/modules/github.png
Normal file
BIN
_site/static/imgs/modules/github.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 106 KiB |
@@ -20,7 +20,7 @@
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/git/">Git</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
|
||||
|
||||
Reference in New Issue
Block a user