Skip to content

Commit

Permalink
Add documentation for GitHub return functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
@senorprogrammer
senorprogrammer committed Sep 26, 2018
1 parent f3eafd5 commit 51c6c14
Show file tree
Hide file tree
Showing 7 changed files with 176 additions and 397 deletions.
5 changes: 4 additions & 1 deletion _site/content/modules/github.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ draft: false
weight: 90
---

<img class="screenshot" src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
<img class="screenshot" src="/imgs/modules/github.png" width="480" height="288" alt="github screenshot" />

Displays information about your git repositories hosted on GitHub:

Expand Down Expand Up @@ -40,6 +40,9 @@ wtf/github/
<span class="caption">Key:</span> `→` <br />
<span class="caption">Action:</span> Show the next git repository.

<span class="caption">Key:</span> `Return` <br />
<span class="caption">Action:</span> Open the selected repository in a browser.

## Configuration

```yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@
"title": "GitHub",
"tags": [],
"description": "",
"content": " Displays information about your git repositories hosted on GitHub:\nOpen Review Requests All open code review requests assigned to you.\nOpen Pull Requests All open pull requests created by you.\nSource Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous git repository.\nKey: l Action: Show the next git repository.\nKey: ← Action: Show the previous git repository.\nKey: → Action: Show the next git repository.\nConfiguration github:apiKey:\u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34;baseURL:\u0026#34;\u0026#34;enabled:trueenableStatus:trueposition:top:2left:3height:2width:2refreshInterval:300repositories:wesker-api:\u0026#34;UmbrellaCorp\u0026#34;wtf:\u0026#34;senorprogrammer\u0026#34;uploadURL:\u0026#34;\u0026#34;username:\u0026#34;senorprogrammer\u0026#34; Attributes apiKey Value: Your GitHub API token.\nbaseURL Optional Value: Your GitHub Enterprise API URL.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nenableStatus Display pull request mergeability status (\u0026lsquo;dirty\u0026rsquo;, \u0026lsquo;clean\u0026rsquo;, \u0026lsquo;unstable\u0026rsquo;, \u0026lsquo;blocked\u0026rsquo;).\nValues: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nrepositories A list of key/value pairs each describing a GitHub repository to fetch data for. Key: The name of the repository. Value: The name of the account or organization that owns the repository.\nuploadURL Optional Value: Your GitHub Enterprise upload URL (often the same as API URL).\nusername Your GitHub username. Used to figure out which review requests you\u0026rsquo;ve been added to.\n"
"content": " Displays information about your git repositories hosted on GitHub:\nOpen Review Requests All open code review requests assigned to you.\nOpen Pull Requests All open pull requests created by you.\nSource Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous git repository.\nKey: l Action: Show the next git repository.\nKey: ← Action: Show the previous git repository.\nKey: → Action: Show the next git repository.\nKey: Return Action: Open the selected repository in a browser.\nConfiguration github:apiKey:\u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34;baseURL:\u0026#34;\u0026#34;enabled:trueenableStatus:trueposition:top:2left:3height:2width:2refreshInterval:300repositories:wesker-api:\u0026#34;UmbrellaCorp\u0026#34;wtf:\u0026#34;senorprogrammer\u0026#34;uploadURL:\u0026#34;\u0026#34;username:\u0026#34;senorprogrammer\u0026#34; Attributes apiKey Value: Your GitHub API token.\nbaseURL Optional Value: Your GitHub Enterprise API URL.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nenableStatus Display pull request mergeability status (\u0026lsquo;dirty\u0026rsquo;, \u0026lsquo;clean\u0026rsquo;, \u0026lsquo;unstable\u0026rsquo;, \u0026lsquo;blocked\u0026rsquo;).\nValues: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nrepositories A list of key/value pairs each describing a GitHub repository to fetch data for. Key: The name of the repository. Value: The name of the account or organization that owns the repository.\nuploadURL Optional Value: Your GitHub Enterprise upload URL (often the same as API URL).\nusername Your GitHub username. Used to figure out which review requests you\u0026rsquo;ve been added to.\n"
},
{
"uri": "https://wtfutil.com/modules/gitlab/",
Expand Down Expand Up @@ -341,4 +341,4 @@
"tags": [],
"description": "",
"content": ""
}]
}]
21 changes: 0 additions & 21 deletions docs/modules/gerrit/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,27 +148,6 @@
<a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/bittrex/">
Bittrex
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/blockfolio/">
Blockfolio
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/cryptolive/">
CryptoLive
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/datadog/" class="dd-item">
Expand Down
3 changes: 3 additions & 0 deletions docs/modules/github/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,9 @@ <h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>→</code> <br />
<span class="caption">Action:</span> Show the next git repository.</p>

<p><span class="caption">Key:</span> <code>Return</code> <br />
<span class="caption">Action:</span> Open the selected repository in a browser.</p>

<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">github<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
Expand Down
173 changes: 167 additions & 6 deletions docs/modules/hackernews/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -219,17 +219,178 @@
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/google/gcal/" class="dd-item">
<li data-nav-id="/modules/bamboohr/" class="dd-item">
<div>
<a href="/modules/bamboohr/">
BambooHR
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/circleci/" class="dd-item">
<div>
<a href="/modules/circleci/">
CircleCI
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/clocks/" class="dd-item">
<div>
<a href="/modules/clocks/">
Clocks
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cmdrunner/" class="dd-item">
<div>
<a href="/modules/cmdrunner/">
CmdRunner
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/datadog/" class="dd-item">
<div>
<a href="/modules/datadog/">
Datadog
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/gerrit/" class="dd-item">
<div>
<a href="/modules/gerrit/">
Gerrit
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/git/" class="dd-item">
<div>
<a href="/modules/git/">
Git
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/github/" class="dd-item">
<div>
<a href="/modules/github/">
GitHub
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/gitlab/" class="dd-item">
<div>
<a href="/modules/gitlab/">
GitLab
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/gitter/" class="dd-item">
<div>
<a href="/modules/google/gcal/">
Google Calendar
<a href="/modules/gitter/">
Gitter
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
<li data-nav-id="/modules/hackernews/" class="dd-item active">
<div>
<a href="/modules/hackernews/">
Hacker News
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/jenkins/" class="dd-item">
<div>
<a href="/modules/google/gspreadsheet/">
Google Spreadsheets
<a href="/modules/jenkins/">
Jenkins
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/jira/" class="dd-item">
<div>
<a href="/modules/jira/">
Jira
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/logger/" class="dd-item">
<div>
<a href="/modules/logger/">
Logger
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/newrelic/" class="dd-item">
<div>
<a href="/modules/newrelic/">
New Relic
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/opsgenie/" class="dd-item">
<div>
<a href="/modules/opsgenie/">
OpsGenie
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/power/" class="dd-item">
<div>
<a href="/modules/power/">
Power
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/security/" class="dd-item">
<div>
<a href="/modules/security/">
Security
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/textfile/" class="dd-item">
<div>
<a href="/modules/textfile/">
Textfile
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/todo/" class="dd-item">
<div>
<a href="/modules/todo/">
Todo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/todoist/" class="dd-item">
<div>
<a href="/modules/todoist/">
Todoist
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/travisci/" class="dd-item">
<div>
<a href="/modules/travisci/">
TravisCI
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/trello/" class="dd-item">
<div>
<a href="/modules/trello/">
Trello
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/twitter/" class="dd-item">
<div>
<a href="/modules/twitter/">
Twitter
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/zendesk/" class="dd-item">
<div>
<a href="/modules/zendesk/">
Zendesk
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
Expand Down
Loading

0 comments on commit 51c6c14

Please sign in to comment.