Skip to content

Commit

Permalink
add docs for gitlab
Browse files Browse the repository at this point in the history
  • Loading branch information
@dlom
dlom committed Jun 8, 2018
1 parent b4970e5 commit d38eb62
Show file tree
Hide file tree
Showing 38 changed files with 369 additions and 4 deletions.
89 changes: 89 additions & 0 deletions _site/content/posts/modules/gitlab.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
title: "Gitlab"
date: 2018-06-08T13:14:11-07:00
draft: false
---

Displays information about your projects hosted on Gitlab:


#### Open Approval Requests

All open merge requests that are requesting your approval.

#### Open Merge Requests

All open merge requests created by you.

<img src="/imgs/modules/gitlab.png" width="640" height="384" alt="gitlab screenshot" />

## Source Code

```bash
wtf/gitlab/
```

## Required ENV Variables

<span class="caption">Key:</span> `WTF_GITLAB_TOKEN` <br />
<span class="caption">Action:</span> A <a href="https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html">Gitlab personal access token</a>. Requires at least `api` access.

## 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 project.

<span class="caption">Key:</span> `l` <br />
<span class="caption">Action:</span> Show the next project.

<span class="caption">Key:</span> `←` <br />
<span class="caption">Action:</span> Show the previous project.

<span class="caption">Key:</span> `→` <br />
<span class="caption">Action:</span> Show the next project.

## Configuration

```yaml
gitlab:
enabled: true
position:
top: 2
left: 3
height: 2
width: 2
refreshInterval: 300
projects:
tasks: "gitlab-org/release"
gitlab-ce: "gitlab-org"
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`.

`domain` <br />
_Optional_. Your Gitlab corporate domain. <br />
Values: A valid URI.

`projects` <br />
A list of key/value pairs each describing a Gitlab project to fetch data
for. <br />
<span class="caption">Key:</span> The name of the project. <br />
<span class="caption">Value:</span> The namespace of the project.

`username` <br />
Your Gitlab username. Used to figure out which requests require your approval
Binary file added _site/static/imgs/modules/gitlab.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions _site/themes/hyde-hyde/layouts/partials/sidebar.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/categories/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
Binary file added docs/imgs/modules/gitlab.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
17 changes: 16 additions & 1 deletion docs/index.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,26 @@
<description>Recent content on WTF - A Terminal Dashboard</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Mon, 04 Jun 2018 20:06:40 -0700</lastBuildDate>
<lastBuildDate>Fri, 08 Jun 2018 13:14:11 -0700</lastBuildDate>

<atom:link href="https://wtfutil.com/index.xml" rel="self" type="application/rss+xml" />


<item>
<title>Gitlab</title>
<link>https://wtfutil.com/posts/modules/gitlab/</link>
<pubDate>Fri, 08 Jun 2018 13:14:11 -0700</pubDate>

<guid>https://wtfutil.com/posts/modules/gitlab/</guid>
<description>Displays information about your projects hosted on Gitlab:
Open Approval Requests All open merge requests that are requesting your approval.
Open Merge Requests All open merge requests created by you.
Source Code wtf/gitlab/ Required ENV Variables Key: WTF_GITLAB_TOKEN Action: A Gitlab personal access token. Requires at least api access.
Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: h Action: Show the previous project.
Key: l Action: Show the next project.</description>
</item>

<item>
<title>Bittrex</title>
<link>https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/</link>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/configuration/attributes/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/configuration/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/configuration/iterm2/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/glossary/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
8 changes: 8 additions & 0 deletions docs/posts/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down Expand Up @@ -99,6 +100,13 @@ <h3 style="color: white;">Content</h3>
<h1 class="title">Posts</h1>
<ul class="posts">
<li>
<span>
<a href="https://wtfutil.com/posts/modules/gitlab/">Gitlab</a>

<time class="pull-right post-list">Jun 08, 2018</time>

</span>
</li><li>
<span>
<a href="https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/">Bittrex</a>

Expand Down
17 changes: 16 additions & 1 deletion docs/posts/index.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,26 @@
<description>Recent content in Posts on WTF - A Terminal Dashboard</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Mon, 04 Jun 2018 20:06:40 -0700</lastBuildDate>
<lastBuildDate>Fri, 08 Jun 2018 13:14:11 -0700</lastBuildDate>

<atom:link href="https://wtfutil.com/posts/index.xml" rel="self" type="application/rss+xml" />


<item>
<title>Gitlab</title>
<link>https://wtfutil.com/posts/modules/gitlab/</link>
<pubDate>Fri, 08 Jun 2018 13:14:11 -0700</pubDate>

<guid>https://wtfutil.com/posts/modules/gitlab/</guid>
<description>Displays information about your projects hosted on Gitlab:
Open Approval Requests All open merge requests that are requesting your approval.
Open Merge Requests All open merge requests created by you.
Source Code wtf/gitlab/ Required ENV Variables Key: WTF_GITLAB_TOKEN Action: A Gitlab personal access token. Requires at least api access.
Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: h Action: Show the previous project.
Key: l Action: Show the next project.</description>
</item>

<item>
<title>Bittrex</title>
<link>https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/</link>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/installation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/modules/bamboohr/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/modules/clocks/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/modules/cmdrunner/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/modules/cryptocurrencies/bittrex/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/modules/cryptocurrencies/cryptolive/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/modules/gcal/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/modules/git/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/posts/modules/github/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h3 style="color: white;">Content</h3>
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/">GitHub</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">Gitlab</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
Expand Down
Loading

0 comments on commit d38eb62

Please sign in to comment.