taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Generate the documentation for the new config changes

Browse Source
This commit is contained in:
Chris Cummer 2018-07-31 15:37:02 -07:00
parent b6036a3eae
commit da9b863625
10 changed files with 101 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/imgs/modules/gerrit.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 36 KiB

53
docs/index.xml
View File

@ -19,12 +19,12 @@
<guid>https://wtfutil.com/posts/modules/zendesk/</guid> <guid>https://wtfutil.com/posts/modules/zendesk/</guid>
<description>Added in v0.1.0. <description>Added in v0.1.0.
Displays tickets in the &amp;ldquo;New&amp;rdquo; status - i.e. have not yet been assigned. Displays tickets in the &amp;ldquo;New&amp;rdquo; status - i.e. have not yet been assigned.
Source Code wtf/zendesk/ Required ENV Variables Key: ZENDESK_API Value: Your Zendesk API Token Source Code wtf/zendesk/ Keyboard Commands Key: [return] Action: Open the selected ticket in the browser.
Key: ZENDESK_DOMAIN Value: Your Zendesk subdomain
Keyboard Commands Key: [return] Action: Open the selected ticket in the browser.
Key: j Action: Select the next item in the list. Key: j Action: Select the next item in the list.
Key: k Action: Select the previous item in the list. Key: k Action: Select the previous item in the list.
Key: ↓ Action: Scroll down the list.</description> Key: ↓ Action: Scroll down the list.
Key: ↑ Action: Scroll up the list.
Configuration zendesk:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:0left:2height:1width:1status:&amp;#34;new&amp;#34;subdomain:&amp;#34;your_domain&amp;#34;username:&amp;#34;your_email@acme.com&amp;#34; Attributes apiKey Value: Your Zendesk API token.</description>
</item> </item>
<item> <item>
@ -35,10 +35,10 @@ Key: ↓ Action: Scroll down the list.</description>
<guid>https://wtfutil.com/posts/modules/travisci/</guid> <guid>https://wtfutil.com/posts/modules/travisci/</guid>
<description>Added in v0.0.12. <description>Added in v0.0.12.
Displays build information for your Travis CI account. Displays build information for your Travis CI account.
Source Code wtf/travisci/ Required ENV Variables Key: WTF_TRAVIS_API_TOKEN Value: Your Travis CI API access token. Source Code wtf/travisci/ Keyboard Commands None.
Keyboard Commands None. Configuration travisci:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:4left:1height:1width:2pro:falserefreshInterval:900 Attributes apiKey Value: Your Travis CI API access token.
Configuration travisci:enabled:trueposition:top:4left:1height:1width:2pro:falserefreshInterval:900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description> position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0.</description>
</item> </item>
<item> <item>
@ -67,11 +67,11 @@ Key: k Action: Select the previous item in the list.</description>
<description>Displays information about your projects hosted on Gerrit: <description>Displays information about your projects hosted on Gerrit:
Open Incoming Reviews All open reviews that are requesting your approval. Open Incoming Reviews All open reviews that are requesting your approval.
My Outgoing Reviews All open reviews created by you. My Outgoing Reviews All open reviews created by you.
Source Code wtf/gerrit/ Required ENV Variables Key: WTF_GERRIT_PASSWORD Action: Your Gerrit HTTP Password. Source Code wtf/gerrit/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: h Action: Show the previous project. Key: h Action: Show the previous project.
Key: l Action: Show the next project. Key: l Action: Show the next project.
Key: ← Action: Show the previous project.</description> Key: ← Action: Show the previous project.
Key: → Action: Show the next project.</description>
</item> </item>
<item> <item>
@ -128,10 +128,10 @@ enabled Determines whether or not this module is executed and if its data displa
<guid>https://wtfutil.com/posts/modules/circleci/</guid> <guid>https://wtfutil.com/posts/modules/circleci/</guid>
<description>Added in v0.0.7. <description>Added in v0.0.7.
Displays build information for your CircleCI account. Displays build information for your CircleCI account.
Source Code wtf/circleci/ Required ENV Variables Key: WTF_CIRCLE_API_KEY Value: Your CircleCI API token. Source Code wtf/circleci/ Keyboard Commands None.
Keyboard Commands None. Configuration circleci:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:4left:1height:1width:2refreshInterval:900 Attributes apiKey Value: Your CircleCI API token.
Configuration circleci:enabled:trueposition:top:4left:1height:1width:2refreshInterval:900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description> position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0.</description>
</item> </item>
<item> <item>
@ -157,9 +157,9 @@ position Where in the grid this module&amp;rsquo;s widget will be displayed.</de
<guid>https://wtfutil.com/posts/modules/jenkins/</guid> <guid>https://wtfutil.com/posts/modules/jenkins/</guid>
<description>Added in v0.0.8. <description>Added in v0.0.8.
Displays jenkins status of given builds in a project or view Displays jenkins status of given builds in a project or view
Source Code wtf/jenkins/ Required ENV Variables Key: WTF_JENKINS_API_KEY Value: Your Jenkins API key. Source Code wtf/jenkins/ Keyboard Commands None.
Keyboard Commands None. Configuration jenkins:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:2left:3height:2width:3refreshInterval:300url:&amp;#34;https://jenkins.domain.com/jenkins/view_url&amp;#34;user:&amp;#34;username&amp;#34;verifyServerCertificate:true Attributes apiKey Value: Your Jenkins API key.
Configuration jenkins:enabled:trueposition:top:2left:3height:2width:3refreshInterval:300url:&amp;#34;https://jenkins.domain.com/jenkins/view_url&amp;#34;user:&amp;#34;username&amp;#34;verifyServerCertificate:true Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. position Defines where in the grid this module&amp;rsquo;s widget will be displayed.
refreshInterval How often, in seconds, this module will update its data.</description> refreshInterval How often, in seconds, this module will update its data.</description>
</item> </item>
@ -174,9 +174,11 @@ refreshInterval How often, in seconds, this module will update its data.</descri
Displays information about your projects hosted on GitLab: Displays information about your projects hosted on GitLab:
Open Approval Requests All open merge requests that are requesting your approval. Open Approval Requests All open merge requests that are requesting your approval.
Open Merge Requests All open merge requests created by you. 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. Source Code wtf/gitlab/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window. Key: h Action: Show the previous project.
Key: h Action: Show the previous project.</description> Key: l Action: Show the next project.
Key: ← Action: Show the previous project.
Key: → Action: Show the next project.</description>
</item> </item>
<item> <item>
@ -355,10 +357,11 @@ Configuration Single Jira Project jira:apiKey:&amp;#34;3276d7155dd9ee27b8b14f874
<guid>https://wtfutil.com/posts/modules/trello/</guid> <guid>https://wtfutil.com/posts/modules/trello/</guid>
<description>Displays all Trello cards on specified lists. <description>Displays all Trello cards on specified lists.
Source Code wtf/trello/ Required ENV Variables Key: WTF_TRELLO_APP_KEY Value: Your Trello App Key. Key: WTF_TRELLO_ACCESS_TOKEN Value: Your Trello Access Token. You can get your API key at: trello.com/app-key. Source Code wtf/trello/ Keyboard Commands None.
Keyboard Commands None. Configuration Single Trello List trello:accessToken:&amp;#34;7b8b14f8743a408a93276d7155dd9ee2&amp;#34;apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;board:Mainenabled:truelist:&amp;#34;Todo&amp;#34;position:height:1left:2top:0width:1refreshInterval:3600username:myname Multiple Trello Lists If you want to monitor multiple Trello lists, use the following configuration (note the difference in list):
Configuration Single Trello List trello:board:Mainenabled:truelist:&amp;#34;Todo&amp;#34;position:height:1left:2top:0width:1refreshInterval:3600username:myname Multiple Trello Lists If you want to monitor multiple Trello lists, use the following configuration (note the difference in list): trello:accessToken:&amp;#34;7b8b14f8743a408a93276d7155dd9ee2&amp;#34;apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;board:Mainenabled:truelist:[&amp;#34;Todo&amp;#34;,&amp;#34;Done&amp;#34;]position:height:1left:2top:0width:1refreshInterval:3600username:myname Attributes accessToken Value: Your Trello access token.
trello:board:Mainenabled:truelist:[&amp;#34;Todo&amp;#34;,&amp;#34;Done&amp;#34;]position:height:1left:2top:0width:1refreshInterval:3600username:myname Attributes board The name of the Trello board.</description> apiKey Value: Your Trello API key.
board The name of the Trello board. enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item> </item>
<item> <item>

53
docs/posts/index.xml
View File

@ -19,12 +19,12 @@
<guid>https://wtfutil.com/posts/modules/zendesk/</guid> <guid>https://wtfutil.com/posts/modules/zendesk/</guid>
<description>Added in v0.1.0. <description>Added in v0.1.0.
Displays tickets in the &amp;ldquo;New&amp;rdquo; status - i.e. have not yet been assigned. Displays tickets in the &amp;ldquo;New&amp;rdquo; status - i.e. have not yet been assigned.
Source Code wtf/zendesk/ Required ENV Variables Key: ZENDESK_API Value: Your Zendesk API Token Source Code wtf/zendesk/ Keyboard Commands Key: [return] Action: Open the selected ticket in the browser.
Key: ZENDESK_DOMAIN Value: Your Zendesk subdomain
Keyboard Commands Key: [return] Action: Open the selected ticket in the browser.
Key: j Action: Select the next item in the list. Key: j Action: Select the next item in the list.
Key: k Action: Select the previous item in the list. Key: k Action: Select the previous item in the list.
Key: ↓ Action: Scroll down the list.</description> Key: ↓ Action: Scroll down the list.
Key: ↑ Action: Scroll up the list.
Configuration zendesk:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:0left:2height:1width:1status:&amp;#34;new&amp;#34;subdomain:&amp;#34;your_domain&amp;#34;username:&amp;#34;your_email@acme.com&amp;#34; Attributes apiKey Value: Your Zendesk API token.</description>
</item> </item>
<item> <item>
@ -35,10 +35,10 @@ Key: ↓ Action: Scroll down the list.</description>
<guid>https://wtfutil.com/posts/modules/travisci/</guid> <guid>https://wtfutil.com/posts/modules/travisci/</guid>
<description>Added in v0.0.12. <description>Added in v0.0.12.
Displays build information for your Travis CI account. Displays build information for your Travis CI account.
Source Code wtf/travisci/ Required ENV Variables Key: WTF_TRAVIS_API_TOKEN Value: Your Travis CI API access token. Source Code wtf/travisci/ Keyboard Commands None.
Keyboard Commands None. Configuration travisci:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:4left:1height:1width:2pro:falserefreshInterval:900 Attributes apiKey Value: Your Travis CI API access token.
Configuration travisci:enabled:trueposition:top:4left:1height:1width:2pro:falserefreshInterval:900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description> position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0.</description>
</item> </item>
<item> <item>
@ -67,11 +67,11 @@ Key: k Action: Select the previous item in the list.</description>
<description>Displays information about your projects hosted on Gerrit: <description>Displays information about your projects hosted on Gerrit:
Open Incoming Reviews All open reviews that are requesting your approval. Open Incoming Reviews All open reviews that are requesting your approval.
My Outgoing Reviews All open reviews created by you. My Outgoing Reviews All open reviews created by you.
Source Code wtf/gerrit/ Required ENV Variables Key: WTF_GERRIT_PASSWORD Action: Your Gerrit HTTP Password. Source Code wtf/gerrit/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: h Action: Show the previous project. Key: h Action: Show the previous project.
Key: l Action: Show the next project. Key: l Action: Show the next project.
Key: ← Action: Show the previous project.</description> Key: ← Action: Show the previous project.
Key: → Action: Show the next project.</description>
</item> </item>
<item> <item>
@ -128,10 +128,10 @@ enabled Determines whether or not this module is executed and if its data displa
<guid>https://wtfutil.com/posts/modules/circleci/</guid> <guid>https://wtfutil.com/posts/modules/circleci/</guid>
<description>Added in v0.0.7. <description>Added in v0.0.7.
Displays build information for your CircleCI account. Displays build information for your CircleCI account.
Source Code wtf/circleci/ Required ENV Variables Key: WTF_CIRCLE_API_KEY Value: Your CircleCI API token. Source Code wtf/circleci/ Keyboard Commands None.
Keyboard Commands None. Configuration circleci:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:4left:1height:1width:2refreshInterval:900 Attributes apiKey Value: Your CircleCI API token.
Configuration circleci:enabled:trueposition:top:4left:1height:1width:2refreshInterval:900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description> position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0.</description>
</item> </item>
<item> <item>
@ -157,9 +157,9 @@ position Where in the grid this module&amp;rsquo;s widget will be displayed.</de
<guid>https://wtfutil.com/posts/modules/jenkins/</guid> <guid>https://wtfutil.com/posts/modules/jenkins/</guid>
<description>Added in v0.0.8. <description>Added in v0.0.8.
Displays jenkins status of given builds in a project or view Displays jenkins status of given builds in a project or view
Source Code wtf/jenkins/ Required ENV Variables Key: WTF_JENKINS_API_KEY Value: Your Jenkins API key. Source Code wtf/jenkins/ Keyboard Commands None.
Keyboard Commands None. Configuration jenkins:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:2left:3height:2width:3refreshInterval:300url:&amp;#34;https://jenkins.domain.com/jenkins/view_url&amp;#34;user:&amp;#34;username&amp;#34;verifyServerCertificate:true Attributes apiKey Value: Your Jenkins API key.
Configuration jenkins:enabled:trueposition:top:2left:3height:2width:3refreshInterval:300url:&amp;#34;https://jenkins.domain.com/jenkins/view_url&amp;#34;user:&amp;#34;username&amp;#34;verifyServerCertificate:true Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. position Defines where in the grid this module&amp;rsquo;s widget will be displayed.
refreshInterval How often, in seconds, this module will update its data.</description> refreshInterval How often, in seconds, this module will update its data.</description>
</item> </item>
@ -174,9 +174,11 @@ refreshInterval How often, in seconds, this module will update its data.</descri
Displays information about your projects hosted on GitLab: Displays information about your projects hosted on GitLab:
Open Approval Requests All open merge requests that are requesting your approval. Open Approval Requests All open merge requests that are requesting your approval.
Open Merge Requests All open merge requests created by you. 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. Source Code wtf/gitlab/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window. Key: h Action: Show the previous project.
Key: h Action: Show the previous project.</description> Key: l Action: Show the next project.
Key: ← Action: Show the previous project.
Key: → Action: Show the next project.</description>
</item> </item>
<item> <item>
@ -355,10 +357,11 @@ Configuration Single Jira Project jira:apiKey:&amp;#34;3276d7155dd9ee27b8b14f874
<guid>https://wtfutil.com/posts/modules/trello/</guid> <guid>https://wtfutil.com/posts/modules/trello/</guid>
<description>Displays all Trello cards on specified lists. <description>Displays all Trello cards on specified lists.
Source Code wtf/trello/ Required ENV Variables Key: WTF_TRELLO_APP_KEY Value: Your Trello App Key. Key: WTF_TRELLO_ACCESS_TOKEN Value: Your Trello Access Token. You can get your API key at: trello.com/app-key. Source Code wtf/trello/ Keyboard Commands None.
Keyboard Commands None. Configuration Single Trello List trello:accessToken:&amp;#34;7b8b14f8743a408a93276d7155dd9ee2&amp;#34;apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;board:Mainenabled:truelist:&amp;#34;Todo&amp;#34;position:height:1left:2top:0width:1refreshInterval:3600username:myname Multiple Trello Lists If you want to monitor multiple Trello lists, use the following configuration (note the difference in list):
Configuration Single Trello List trello:board:Mainenabled:truelist:&amp;#34;Todo&amp;#34;position:height:1left:2top:0width:1refreshInterval:3600username:myname Multiple Trello Lists If you want to monitor multiple Trello lists, use the following configuration (note the difference in list): trello:accessToken:&amp;#34;7b8b14f8743a408a93276d7155dd9ee2&amp;#34;apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;board:Mainenabled:truelist:[&amp;#34;Todo&amp;#34;,&amp;#34;Done&amp;#34;]position:height:1left:2top:0width:1refreshInterval:3600username:myname Attributes accessToken Value: Your Trello access token.
trello:board:Mainenabled:truelist:[&amp;#34;Todo&amp;#34;,&amp;#34;Done&amp;#34;]position:height:1left:2top:0width:1refreshInterval:3600username:myname Attributes board The name of the Trello board.</description> apiKey Value: Your Trello API key.
board The name of the Trello board. enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item> </item>
<item> <item>

10
docs/posts/modules/circleci/index.html
View File

@ -145,18 +145,13 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2> <h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/circleci/</code></pre></div> <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/circleci/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_CIRCLE_API_KEY</code> <br />
<span class="caption">Value:</span> Your <a href="https://circleci.com/account/api">CircleCI API</a>
token.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2> <h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p> <p>None.</p>
<h2 id="configuration">Configuration</h2> <h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">circleci<span class="p">:</span><span class="w"> <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">circleci<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">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w"> </span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w"> </span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
@ -166,6 +161,9 @@ token.</p>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span></code></pre></div> </span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span></code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your <a href="https://circleci.com/account/api">CircleCI API</a> token.</p>
<p><code>enabled</code> <br /> <p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br /> Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p> Values: <code>true</code>, <code>false</code>.</p>

15
docs/posts/modules/gerrit/index.html
View File

@ -137,8 +137,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<p><img src="/imgs/modules/gerrit.png" width="640" height="384" alt="gerrit screenshot" /></p>
<p>Displays information about your projects hosted on Gerrit:</p> <p>Displays information about your projects hosted on Gerrit:</p>
<h4 id="open-incoming-reviews">Open Incoming Reviews</h4> <h4 id="open-incoming-reviews">Open Incoming Reviews</h4>
@ -149,13 +147,10 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<p>All open reviews created by you.</p> <p>All open reviews created by you.</p>
<p><img src="/imgs/modules/gerrit.png" width="640" height="167" alt="gerrit screenshot" /></p>
<h2 id="source-code">Source Code</h2> <h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/gerrit/</code></pre></div> <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/gerrit/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_GERRIT_PASSWORD</code> <br />
<span class="caption">Action:</span> Your <a href="https://gerrit-review.googlesource.com/Documentation/user-upload.html#http">Gerrit HTTP Password</a>.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2> <h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>/</code> <br /> <p><span class="caption">Key:</span> <code>/</code> <br />
@ -186,6 +181,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
</span><span class="w"> </span>projects<span class="p">:</span><span class="w"> </span><span class="w"> </span>projects<span class="p">:</span><span class="w">
</span><span class="w"> </span>-<span class="w"> </span>org/test-project<span class="s2">&#34; </span><span class="w"> </span>-<span class="w"> </span>org/test-project<span class="s2">&#34;
</span><span class="s2"> - dotfiles </span><span class="s2"> - dotfiles
</span><span class="s2"> password: &#34;</span>mypassword<span class="s2">&#34;
</span><span class="s2"> username: &#34;</span>myname&#34;<span class="w"> </span><span class="s2"> username: &#34;</span>myname&#34;<span class="w">
</span><span class="w"> </span>verifyServerCertificate<span class="p">:</span><span class="w"> </span><span class="kc">false</span></code></pre></div> </span><span class="w"> </span>verifyServerCertificate<span class="p">:</span><span class="w"> </span><span class="kc">false</span></code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>
@ -208,8 +204,11 @@ Values: A valid URI.</p>
<p><code>projects</code> <br /> <p><code>projects</code> <br />
A list of Gerrit project names to fetch data for. <br /></p> A list of Gerrit project names to fetch data for. <br /></p>
<p><code>password</code> <br />
Value: Your <a href="https://gerrit-review.googlesource.com/Documentation/user-upload.html#http">Gerrit HTTP Password</a>.</p>
<p><code>username</code> <br /> <p><code>username</code> <br />
Your Gerrit username. <br /></p> Your Gerrit username.</p>
<p><code>verifyServerCertificate</code> <br /> <p><code>verifyServerCertificate</code> <br />
<em>Optional</em> <br /> <em>Optional</em> <br />

9
docs/posts/modules/gitlab/index.html
View File

@ -153,11 +153,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2> <h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/gitlab/</code></pre></div> <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/gitlab/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_GITLAB_TOKEN</code> <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 <code>api</code> access.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2> <h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>/</code> <br /> <p><span class="caption">Key:</span> <code>/</code> <br />
@ -177,6 +172,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="configuration">Configuration</h2> <h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">gitlab<span class="p">:</span><span class="w"> <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">gitlab<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">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w"> </span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
@ -190,6 +186,9 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;senorprogrammer&#34;</span></code></pre></div> </span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;senorprogrammer&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: A <a href="https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html">GitLab personal access token</a>. Requires at least <code>api</code> access.</p>
<p><code>enabled</code> <br /> <p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br /> Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p> Values: <code>true</code>, <code>false</code>.</p>

9
docs/posts/modules/jenkins/index.html
View File

@ -146,17 +146,13 @@ width="320" height="68" alt="jenkins screenshot" /></p>
<h2 id="source-code">Source Code</h2> <h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/jenkins/</code></pre></div> <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/jenkins/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_JENKINS_API_KEY</code> <br />
<span class="caption">Value:</span> Your <a href="https://wiki.jenkins.io/display/JENKINS/Remote+access+API">Jenkins API</a> key.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2> <h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p> <p>None.</p>
<h2 id="configuration">Configuration</h2> <h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">jenkins<span class="p">:</span><span class="w"> <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">jenkins<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">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w"> </span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
@ -169,6 +165,9 @@ width="320" height="68" alt="jenkins screenshot" /></p>
</span><span class="w"> </span>verifyServerCertificate<span class="p">:</span><span class="w"> </span><span class="kc">true</span></code></pre></div> </span><span class="w"> </span>verifyServerCertificate<span class="p">:</span><span class="w"> </span><span class="kc">true</span></code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your <a href="https://wiki.jenkins.io/display/JENKINS/Remote+access+API">Jenkins API</a> key.</p>
<p><code>enabled</code> <br /> <p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br /> Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p> Values: <code>true</code>, <code>false</code>.</p>

9
docs/posts/modules/travisci/index.html
View File

@ -145,17 +145,13 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2> <h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/travisci/</code></pre></div> <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/travisci/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_TRAVIS_API_TOKEN</code> <br />
<span class="caption">Value:</span> Your <a href="https://developer.travis-ci.org/authentication">Travis CI API</a> access token.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2> <h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p> <p>None.</p>
<h2 id="configuration">Configuration</h2> <h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">travisci<span class="p">:</span><span class="w"> <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">travisci<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">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w"> </span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w"> </span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
@ -166,6 +162,9 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span></code></pre></div> </span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span></code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your <a href="https://developer.travis-ci.org/authentication">Travis CI API</a> access token.</p>
<p><code>enabled</code> <br /> <p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br /> Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p> Values: <code>true</code>, <code>false</code>.</p>

19
docs/posts/modules/trello/index.html
View File

@ -143,15 +143,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2> <h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/trello/</code></pre></div> <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/trello/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_TRELLO_APP_KEY</code> <br />
<span class="caption">Value:</span> Your Trello App Key. <br />
<span class="caption">Key:</span> <code>WTF_TRELLO_ACCESS_TOKEN</code> <br />
<span class="caption">Value:</span> Your Trello Access Token. <br /></p>
<p><em>You can get your API key at: trello.com/app-key.</em></p>
<h2 id="keyboard-commands">Keyboard Commands</h2> <h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p> <p>None.</p>
@ -160,6 +151,8 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h3 id="single-trello-list">Single Trello List</h3> <h3 id="single-trello-list">Single Trello List</h3>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">trello<span class="p">:</span><span class="w"> <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">trello<span class="p">:</span><span class="w">
</span><span class="w"> </span>accessToken<span class="p">:</span><span class="w"> </span><span class="s2">&#34;7b8b14f8743a408a93276d7155dd9ee2&#34;</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">
</span><span class="w"> </span>board<span class="p">:</span><span class="w"> </span>Main<span class="w"> </span><span class="w"> </span>board<span class="p">:</span><span class="w"> </span>Main<span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>list<span class="p">:</span><span class="w"> </span><span class="s2">&#34;Todo&#34;</span><span class="w"> </span><span class="w"> </span>list<span class="p">:</span><span class="w"> </span><span class="s2">&#34;Todo&#34;</span><span class="w">
@ -175,6 +168,8 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<p>If you want to monitor multiple Trello lists, use the following <p>If you want to monitor multiple Trello lists, use the following
configuration (note the difference in <code>list</code>):</p> configuration (note the difference in <code>list</code>):</p>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">trello<span class="p">:</span><span class="w"> <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">trello<span class="p">:</span><span class="w">
</span><span class="w"> </span>accessToken<span class="p">:</span><span class="w"> </span><span class="s2">&#34;7b8b14f8743a408a93276d7155dd9ee2&#34;</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">
</span><span class="w"> </span>board<span class="p">:</span><span class="w"> </span>Main<span class="w"> </span><span class="w"> </span>board<span class="p">:</span><span class="w"> </span>Main<span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>list<span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&#34;Todo&#34;</span><span class="p">,</span><span class="w"> </span><span class="s2">&#34;Done&#34;</span><span class="p">]</span><span class="w"> </span><span class="w"> </span>list<span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&#34;Todo&#34;</span><span class="p">,</span><span class="w"> </span><span class="s2">&#34;Done&#34;</span><span class="p">]</span><span class="w">
@ -187,6 +182,12 @@ configuration (note the difference in <code>list</code>):</p>
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span>myname</code></pre></div> </span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span>myname</code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>
<p><code>accessToken</code> <br />
Value: Your Trello access token.</p>
<p><code>apiKey</code> <br />
Value: Your Trello API key.</p>
<p><code>board</code> <br /> <p><code>board</code> <br />
The name of the Trello board. <br /></p> The name of the Trello board. <br /></p>

16
docs/posts/modules/zendesk/index.html
View File

@ -143,14 +143,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2> <h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/zendesk/</code></pre></div> <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/zendesk/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>ZENDESK_API</code> <br />
<span class="caption">Value:</span> Your Zendesk API Token</p>
<p><span class="caption">Key:</span> <code>ZENDESK_DOMAIN</code> <br />
<span class="caption">Value:</span> Your Zendesk subdomain</p>
<h2 id="keyboard-commands">Keyboard Commands</h2> <h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>[return]</code> <br /> <p><span class="caption">Key:</span> <code>[return]</code> <br />
@ -170,6 +162,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="configuration">Configuration</h2> <h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">zendesk<span class="p">:</span><span class="w"> <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">zendesk<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">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w"> </span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w">
@ -177,9 +170,13 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>status<span class="p">:</span><span class="w"> </span><span class="s2">&#34;new&#34;</span><span class="w"> </span><span class="w"> </span>status<span class="p">:</span><span class="w"> </span><span class="s2">&#34;new&#34;</span><span class="w">
</span><span class="w"> </span>subdomain<span class="p">:</span><span class="w"> </span><span class="s2">&#34;your_domain&#34;</span><span class="w">
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;your_email@acme.com&#34;</span></code></pre></div> </span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;your_email@acme.com&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your Zendesk API token.</p>
<p><code>enabled</code> <br /> <p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br /> Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p> Values: <code>true</code>, <code>false</code>.</p>
@ -191,6 +188,9 @@ Defines where in the grid this module&rsquo;s widget will be displayed. <br /></
The status of tickets you want to retrieve. The status of tickets you want to retrieve.
Values: <code>new</code>, <code>open</code>, <code>pending</code>, <code>hold</code>.</p> Values: <code>new</code>, <code>open</code>, <code>pending</code>, <code>hold</code>.</p>
<p><code>subdomain</code> <br />
Value: Your Zendesk subdomain.</p>
<p><code>username</code> <br /> <p><code>username</code> <br />
Your Zendesk username Your Zendesk username
Values: A valid Zendesk username (usually an email address).</p> Values: A valid Zendesk username (usually an email address).</p>