1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Adds the New Relic and Textfile modules to the documentation

This commit is contained in:
Chris Cummer
2018-05-09 11:28:04 -07:00
parent 7adc0cdb11
commit decc8cd5e5
31 changed files with 607 additions and 61 deletions

View File

@@ -26,10 +26,10 @@ Available modules:
<li><a href="/posts/modules/github" class="disabled">Github</a>
<li><a href="/posts/modules/gcal" class="disabled">Google Calendar</a>
<li><a href="/posts/modules/jira" class="disabled">Jira</a>
<li><a href="/posts/modules/newrelic" class="disabled">New Relic</a>
<li><a href="/posts/modules/newrelic">New Relic</a>
<li><a href="/posts/modules/opsgenie">OpsGenie</a>
<li><a href="/posts/modules/security">Security</a>
<li><a href="/posts/modules/textfiles" class="disabled">Text Files</a>
<li><a href="/posts/modules/textfile">Text File</a>
<li><a href="/posts/modules/todo" class="disabled">Todo</a>
<li><a href="/posts/modules/weather" class="disabled">Weather</a>
</ul>

View File

@@ -8,7 +8,7 @@ draft: false
Connects to the BambooHR API and displays who will be Away today.
## Location
## Source Code
```bash
wtf/bamboohr

View File

@@ -10,7 +10,7 @@ Displays a configurable list of world clocks, the local time, and date.
<img src="/imgs/modules/clocks.png" width="320" height="191" alt="clocks screenshot" />
## Location
## Source Code
```bash
wtf/clocks/

View File

@@ -0,0 +1,65 @@
---
title: "Newrelic"
date: 2018-05-09T09:01:14-07:00
draft: false
---
## Description
Connects to the New Relic API and displays the last n deploys of the
monitored application: deploy ID, deploy time, and who deployed it.
<img src="/imgs/modules/newrelic.png" width="640" height="189" alt="newrelic screenshot" />
## Source Code
```bash
wtf/newrelic/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_NEW_RELIC_API_KEY` <br />
<span class="caption">Value:</span> Your <a href="">New Relic API</a>
token.
## Keyboard Commands
None.
## Configuration
```yaml
newrelic:
applicationId: 10549735
deployCount: 6
enabled: true
position:
top: 4
left: 3
height: 1
width: 2
refreshInterval: 900
```
### Attributes
`applicationId` <br />
The integer ID of the New Relic application you wish to report on. <br
/>
Values: A positive integer, `0...n`.
`deployCount` <br />
The number of past deploys to display on screen. <br />
Values: A positive integer, `0...n`.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`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`.

View File

@@ -11,10 +11,10 @@ and who's currently on call.
<img src="/imgs/modules/opsgenie.png" width="320" height="389" alt="opsgenie screenshot" />
## Location
## Source Code
```bash
wtf/opsgenie
wtf/opsgenie/
```
## Required ENV Variables
@@ -51,4 +51,4 @@ 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: Any positive integer, `0...n`.
Values: A positive integer, `0...n`.

View File

@@ -31,7 +31,7 @@ connection, firewall, and DNS settings.
<li>Which <a hre="https://developers.cloudflare.com/1.1.1.1/what-is-1.1.1.1/">DNS resolvers</a> (servers) the machine is configured to use</li>
</ul>
## Location
## Source Code
```bash
wtf/security

View File

@@ -0,0 +1,62 @@
---
title: "Textfile"
date: 2018-05-09T11:13:11-07:00
draft: false
---
## Description
Displays the contents of the specified text file in the widget.
<img src="/imgs/modules/textfile.png" width="320" height="133" alt="textfile screenshot" />
## Source Code
```bash
wtf/textfile/
```
## Required ENV Variables
None.
## Keyboard Commands
<span class="caption">Key:</span> `h` <br />
<span class="caption">Action:</span> Open/close the widget's help window.
<span class="caption">Key:</span> `o` <br />
<span class="caption">Action:</span> Opens the text file in whichever
text editor is associated with that file type.
## Configuration
```yaml
textfile:
enabled: true
filename: "notes.md"
position:
top: 5
left: 4
height: 2
width: 1
refreshInterval: 15
```
### Attributes
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`filename` <br />
The name of the file to be displayed in the widget. <br />
*Note:* Currently this file *must* reside in the `~/.wtf/` directory.
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>.
`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`.