diff --git a/docs/imgs/modules/gerrit.png b/docs/imgs/modules/gerrit.png index 6084dc1d..8b472e5c 100644 Binary files a/docs/imgs/modules/gerrit.png and b/docs/imgs/modules/gerrit.png differ diff --git a/docs/index.xml b/docs/index.xml index c36ed99b..5b9a2732 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -19,12 +19,12 @@ https://wtfutil.com/posts/modules/zendesk/ Added in v0.1.0. Displays tickets in the “New” status - i.e. have not yet been assigned. -Source Code wtf/zendesk/ Required ENV Variables Key: ZENDESK_API Value: Your Zendesk API Token -Key: ZENDESK_DOMAIN Value: Your Zendesk subdomain -Keyboard Commands Key: [return] Action: Open the selected ticket in the browser. +Source Code wtf/zendesk/ Keyboard Commands Key: [return] Action: Open the selected ticket in the browser. Key: j Action: Select the next item in the list. Key: k Action: Select the previous item in the list. -Key: ↓ Action: Scroll down the list. +Key: ↓ Action: Scroll down the list. +Key: ↑ Action: Scroll up the list. +Configuration zendesk:apiKey:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:0left:2height:1width:1status:"new"subdomain:"your_domain"username:"your_email@acme.com" Attributes apiKey Value: Your Zendesk API token. @@ -35,10 +35,10 @@ Key: ↓ Action: Scroll down the list. https://wtfutil.com/posts/modules/travisci/ Added in v0.0.12. 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. -Keyboard Commands None. -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. -position Defines where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. +Source Code wtf/travisci/ Keyboard Commands None. +Configuration travisci:apiKey:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:4left:1height:1width:2pro:falserefreshInterval:900 Attributes apiKey Value: Your Travis CI API access token. +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’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0. @@ -67,11 +67,11 @@ Key: k Action: Select the previous item in the list. Displays information about your projects hosted on Gerrit: Open Incoming Reviews All open reviews that are requesting your approval. 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. -Keyboard Commands Key: / Action: Open/close the widget’s help window. +Source Code wtf/gerrit/ Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: h Action: Show the previous project. Key: l Action: Show the next project. -Key: ← Action: Show the previous project. +Key: ← Action: Show the previous project. +Key: → Action: Show the next project. @@ -128,10 +128,10 @@ enabled Determines whether or not this module is executed and if its data displa https://wtfutil.com/posts/modules/circleci/ Added in v0.0.7. Displays build information for your CircleCI account. -Source Code wtf/circleci/ Required ENV Variables Key: WTF_CIRCLE_API_KEY Value: Your CircleCI API token. -Keyboard Commands None. -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. -position Defines where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. +Source Code wtf/circleci/ Keyboard Commands None. +Configuration circleci:apiKey:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:4left:1height:1width:2refreshInterval:900 Attributes apiKey Value: Your CircleCI API token. +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’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0. @@ -157,9 +157,9 @@ position Where in the grid this module’s widget will be displayed.https://wtfutil.com/posts/modules/jenkins/ Added in v0.0.8. 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. -Keyboard Commands None. -Configuration jenkins:enabled:trueposition:top:2left:3height:2width:3refreshInterval:300url:"https://jenkins.domain.com/jenkins/view_url"user:"username"verifyServerCertificate:true Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. +Source Code wtf/jenkins/ Keyboard Commands None. +Configuration jenkins:apiKey:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:2left:3height:2width:3refreshInterval:300url:"https://jenkins.domain.com/jenkins/view_url"user:"username"verifyServerCertificate:true Attributes apiKey Value: Your Jenkins API key. +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’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. @@ -174,9 +174,11 @@ refreshInterval How often, in seconds, this module will update its data. +Source Code wtf/gitlab/ Keyboard Commands Key: / Action: Open/close the widget’s help window. +Key: h Action: Show the previous project. +Key: l Action: Show the next project. +Key: ← Action: Show the previous project. +Key: → Action: Show the next project. @@ -355,10 +357,11 @@ Configuration Single Jira Project jira:apiKey:"3276d7155dd9ee27b8b14f874 https://wtfutil.com/posts/modules/trello/ 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. -Keyboard Commands None. -Configuration Single Trello List trello:board:Mainenabled:truelist:"Todo"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:board:Mainenabled:truelist:["Todo","Done"]position:height:1left:2top:0width:1refreshInterval:3600username:myname Attributes board The name of the Trello board. +Source Code wtf/trello/ Keyboard Commands None. +Configuration Single Trello List trello:accessToken:"7b8b14f8743a408a93276d7155dd9ee2"apiKey:"3276d7155dd9ee27b8b14f8743a408a9"board:Mainenabled:truelist:"Todo"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:"7b8b14f8743a408a93276d7155dd9ee2"apiKey:"3276d7155dd9ee27b8b14f8743a408a9"board:Mainenabled:truelist:["Todo","Done"]position:height:1left:2top:0width:1refreshInterval:3600username:myname Attributes accessToken Value: Your Trello access token. +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. diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 24b26896..a77a62f4 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -19,12 +19,12 @@ https://wtfutil.com/posts/modules/zendesk/ Added in v0.1.0. Displays tickets in the “New” status - i.e. have not yet been assigned. -Source Code wtf/zendesk/ Required ENV Variables Key: ZENDESK_API Value: Your Zendesk API Token -Key: ZENDESK_DOMAIN Value: Your Zendesk subdomain -Keyboard Commands Key: [return] Action: Open the selected ticket in the browser. +Source Code wtf/zendesk/ Keyboard Commands Key: [return] Action: Open the selected ticket in the browser. Key: j Action: Select the next item in the list. Key: k Action: Select the previous item in the list. -Key: ↓ Action: Scroll down the list. +Key: ↓ Action: Scroll down the list. +Key: ↑ Action: Scroll up the list. +Configuration zendesk:apiKey:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:0left:2height:1width:1status:"new"subdomain:"your_domain"username:"your_email@acme.com" Attributes apiKey Value: Your Zendesk API token. @@ -35,10 +35,10 @@ Key: ↓ Action: Scroll down the list. https://wtfutil.com/posts/modules/travisci/ Added in v0.0.12. 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. -Keyboard Commands None. -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. -position Defines where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. +Source Code wtf/travisci/ Keyboard Commands None. +Configuration travisci:apiKey:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:4left:1height:1width:2pro:falserefreshInterval:900 Attributes apiKey Value: Your Travis CI API access token. +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’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0. @@ -67,11 +67,11 @@ Key: k Action: Select the previous item in the list. Displays information about your projects hosted on Gerrit: Open Incoming Reviews All open reviews that are requesting your approval. 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. -Keyboard Commands Key: / Action: Open/close the widget’s help window. +Source Code wtf/gerrit/ Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: h Action: Show the previous project. Key: l Action: Show the next project. -Key: ← Action: Show the previous project. +Key: ← Action: Show the previous project. +Key: → Action: Show the next project. @@ -128,10 +128,10 @@ enabled Determines whether or not this module is executed and if its data displa https://wtfutil.com/posts/modules/circleci/ Added in v0.0.7. Displays build information for your CircleCI account. -Source Code wtf/circleci/ Required ENV Variables Key: WTF_CIRCLE_API_KEY Value: Your CircleCI API token. -Keyboard Commands None. -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. -position Defines where in the grid this module’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. +Source Code wtf/circleci/ Keyboard Commands None. +Configuration circleci:apiKey:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:4left:1height:1width:2refreshInterval:900 Attributes apiKey Value: Your CircleCI API token. +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’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0. @@ -157,9 +157,9 @@ position Where in the grid this module’s widget will be displayed.https://wtfutil.com/posts/modules/jenkins/ Added in v0.0.8. 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. -Keyboard Commands None. -Configuration jenkins:enabled:trueposition:top:2left:3height:2width:3refreshInterval:300url:"https://jenkins.domain.com/jenkins/view_url"user:"username"verifyServerCertificate:true Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. +Source Code wtf/jenkins/ Keyboard Commands None. +Configuration jenkins:apiKey:"3276d7155dd9ee27b8b14f8743a408a9"enabled:trueposition:top:2left:3height:2width:3refreshInterval:300url:"https://jenkins.domain.com/jenkins/view_url"user:"username"verifyServerCertificate:true Attributes apiKey Value: Your Jenkins API key. +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’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. @@ -174,9 +174,11 @@ refreshInterval How often, in seconds, this module will update its data. +Source Code wtf/gitlab/ Keyboard Commands Key: / Action: Open/close the widget’s help window. +Key: h Action: Show the previous project. +Key: l Action: Show the next project. +Key: ← Action: Show the previous project. +Key: → Action: Show the next project. @@ -355,10 +357,11 @@ Configuration Single Jira Project jira:apiKey:"3276d7155dd9ee27b8b14f874 https://wtfutil.com/posts/modules/trello/ 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. -Keyboard Commands None. -Configuration Single Trello List trello:board:Mainenabled:truelist:"Todo"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:board:Mainenabled:truelist:["Todo","Done"]position:height:1left:2top:0width:1refreshInterval:3600username:myname Attributes board The name of the Trello board. +Source Code wtf/trello/ Keyboard Commands None. +Configuration Single Trello List trello:accessToken:"7b8b14f8743a408a93276d7155dd9ee2"apiKey:"3276d7155dd9ee27b8b14f8743a408a9"board:Mainenabled:truelist:"Todo"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:"7b8b14f8743a408a93276d7155dd9ee2"apiKey:"3276d7155dd9ee27b8b14f8743a408a9"board:Mainenabled:truelist:["Todo","Done"]position:height:1left:2top:0width:1refreshInterval:3600username:myname Attributes accessToken Value: Your Trello access token. +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. diff --git a/docs/posts/modules/circleci/index.html b/docs/posts/modules/circleci/index.html index af9134f0..0c9799b5 100644 --- a/docs/posts/modules/circleci/index.html +++ b/docs/posts/modules/circleci/index.html @@ -145,18 +145,13 @@ height="0" width="0" style="display:none;visibility:hidden">

Source Code

wtf/circleci/
-

Required ENV Variables

- -

Key: WTF_CIRCLE_API_KEY
-Value: Your CircleCI API -token.

-

Keyboard Commands

None.

Configuration

circleci:
+  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
   enabled: true
   position:
     top: 4
@@ -166,6 +161,9 @@ token.

   refreshInterval: 900

Attributes

+

apiKey
+Value: Your CircleCI API token.

+

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

diff --git a/docs/posts/modules/gerrit/index.html b/docs/posts/modules/gerrit/index.html index f117f95b..e13b2612 100644 --- a/docs/posts/modules/gerrit/index.html +++ b/docs/posts/modules/gerrit/index.html @@ -137,8 +137,6 @@ height="0" width="0" style="display:none;visibility:hidden"> -

gerrit screenshot

-

Displays information about your projects hosted on Gerrit:

Open Incoming Reviews

@@ -149,13 +147,10 @@ height="0" width="0" style="display:none;visibility:hidden">

All open reviews created by you.

+

gerrit screenshot

+

Source Code

wtf/gerrit/
-

Required ENV Variables

- -

Key: WTF_GERRIT_PASSWORD
-Action: Your Gerrit HTTP Password.

-

Keyboard Commands

Key: /
@@ -186,6 +181,7 @@ height="0" width="0" style="display:none;visibility:hidden"> projects: - org/test-project" - dotfiles + password: "mypassword" username: "myname" verifyServerCertificate: false

Attributes

@@ -208,8 +204,11 @@ Values: A valid URI.

projects
A list of Gerrit project names to fetch data for.

+

password
+Value: Your Gerrit HTTP Password.

+

username
-Your Gerrit username.

+Your Gerrit username.

verifyServerCertificate
Optional
diff --git a/docs/posts/modules/gitlab/index.html b/docs/posts/modules/gitlab/index.html index 67546e1e..21246d6d 100644 --- a/docs/posts/modules/gitlab/index.html +++ b/docs/posts/modules/gitlab/index.html @@ -153,11 +153,6 @@ height="0" width="0" style="display:none;visibility:hidden">

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: /
@@ -177,6 +172,7 @@ height="0" width="0" style="display:none;visibility:hidden">

Configuration

gitlab:
+  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
   enabled: true
   position:
     top: 2
@@ -190,6 +186,9 @@ height="0" width="0" style="display:none;visibility:hidden">
   username: "senorprogrammer"

Attributes

+

apiKey
+Value: A GitLab personal access token. Requires at least api access.

+

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

diff --git a/docs/posts/modules/jenkins/index.html b/docs/posts/modules/jenkins/index.html index d38f9d8b..73b7009d 100644 --- a/docs/posts/modules/jenkins/index.html +++ b/docs/posts/modules/jenkins/index.html @@ -146,17 +146,13 @@ width="320" height="68" alt="jenkins screenshot" />

Source Code

wtf/jenkins/
-

Required ENV Variables

- -

Key: WTF_JENKINS_API_KEY
-Value: Your Jenkins API key.

-

Keyboard Commands

None.

Configuration

jenkins:
+  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
   enabled: true
   position:
     top: 2
@@ -169,6 +165,9 @@ width="320" height="68" alt="jenkins screenshot" />

   verifyServerCertificate: true

Attributes

+

apiKey
+Value: Your Jenkins API key.

+

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

diff --git a/docs/posts/modules/travisci/index.html b/docs/posts/modules/travisci/index.html index cf28640f..80fb84ba 100644 --- a/docs/posts/modules/travisci/index.html +++ b/docs/posts/modules/travisci/index.html @@ -145,17 +145,13 @@ height="0" width="0" style="display:none;visibility:hidden">

Source Code

wtf/travisci/
-

Required ENV Variables

- -

Key: WTF_TRAVIS_API_TOKEN
-Value: Your Travis CI API access token.

-

Keyboard Commands

None.

Configuration

travisci:
+  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
   enabled: true
   position:
     top: 4
@@ -166,6 +162,9 @@ height="0" width="0" style="display:none;visibility:hidden">
   refreshInterval: 900

Attributes

+

apiKey
+Value: Your Travis CI API access token.

+

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

diff --git a/docs/posts/modules/trello/index.html b/docs/posts/modules/trello/index.html index ff6efcb0..7be6552e 100644 --- a/docs/posts/modules/trello/index.html +++ b/docs/posts/modules/trello/index.html @@ -143,15 +143,6 @@ height="0" width="0" style="display:none;visibility:hidden">

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.

-

Keyboard Commands

None.

@@ -159,11 +150,13 @@ height="0" width="0" style="display:none;visibility:hidden">

Configuration

Single Trello List

-
trello: 
+
trello:
+  accessToken: "7b8b14f8743a408a93276d7155dd9ee2"
+  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
   board: Main
   enabled: true
   list: "Todo"
-  position: 
+  position:
     height: 1
     left: 2
     top: 0
@@ -174,11 +167,13 @@ height="0" width="0" style="display:none;visibility:hidden">
 
 
If you want to monitor multiple Trello lists, use the following
 configuration (note the difference in list):

-
trello: 
+
trello:
+  accessToken: "7b8b14f8743a408a93276d7155dd9ee2"
+  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
   board: Main
   enabled: true
   list: ["Todo", "Done"]
-  position: 
+  position:
     height: 1
     left: 2
     top: 0
@@ -187,6 +182,12 @@ configuration (note the difference in list):

   username: myname

 
Attributes

 
+
accessToken 

+Value: Your Trello access token.

+
+
apiKey 

+Value: Your Trello API key.

+
 
board 

 The name of the Trello board. 

 
diff --git a/docs/posts/modules/zendesk/index.html b/docs/posts/modules/zendesk/index.html
index 0afa4c1b..0ef1b309 100644
--- a/docs/posts/modules/zendesk/index.html
+++ b/docs/posts/modules/zendesk/index.html
@@ -143,14 +143,6 @@ height="0" width="0" style="display:none;visibility:hidden">
 
 
Source Code

 
wtf/zendesk/

-
Required ENV Variables

-
-
Key: ZENDESK_API 

-Value: Your Zendesk API Token

-
-
Key: ZENDESK_DOMAIN 

-Value: Your Zendesk subdomain

-
 
Keyboard Commands

 
 
Key: [return] 

@@ -170,6 +162,7 @@ height="0" width="0" style="display:none;visibility:hidden">
 
 
Configuration

 
zendesk:
+  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
   enabled: true
   position:
     top: 0
@@ -177,9 +170,13 @@ height="0" width="0" style="display:none;visibility:hidden">
     height: 1
     width: 1
   status: "new"
+  subdomain: "your_domain"
   username: "your_email@acme.com"

 
Attributes

 
+
apiKey 

+Value: Your Zendesk API token.

+
 
enabled 

 Determines whether or not this module is executed and if its data displayed onscreen. 

 Values: true, false.

@@ -191,6 +188,9 @@ Defines where in the grid this module’s widget will be displayed. 
new, open, pending, hold.

 
+
subdomain 

+Value: Your Zendesk subdomain.

+
 
username 

 Your Zendesk username
 Values: A valid Zendesk username (usually an email address).