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

More documentation for Clocks, OpsGenie, and Todo.

Browse Source
This commit is contained in:
Chris Cummer 2018-05-16 19:42:23 -07:00
parent 40ca748b8d
commit 694490b0ca
8 changed files with 32 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_site/content/posts/modules/clocks.md
View File

@ -53,12 +53,12 @@ clocks:
### Attributes
`colors.rows.even` <br />
Define the foreground color for even-numbered rows. <br />
The foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`colors.rows.odd` <br />
Define the foreground color for the odd-numbered rows. <br />
The foreground color for the odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.

9
_site/content/posts/modules/opsgenie.md
View File

@ -31,6 +31,7 @@ None.
```yaml
opsgenie:
displayEmpty: false
enabled: true
position:
top: 2
@ -42,12 +43,16 @@ opsgenie:
### Attributes
`displayEmpty` <br />
Whether schedules with no assigned person on-call should be displayed. <br />
Values: `true`, `false`.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
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 />
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 />

4
_site/content/posts/modules/todo.md
View File

@ -94,9 +94,11 @@ Values: Any displayable unicode character.
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
`colors.highlight.fore` <br />
The foreground color for the currently-selected row. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
`colors.highlight.back` <br />
The background color for the currently-selected row. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
`enabled` <br />
@ -105,8 +107,6 @@ Values: `true`, `false`.
`filename` <br />
The name for the todo file. <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>. <br />
Values: Any valid filename, ideally ending in `yml`.
`position` <br />

9
docs/index.xml
View File

@ -135,8 +135,9 @@ deployCount The number of past deploys to display on screen.</description>
<description>Description Connects to the OpsGenie API and displays all your scheduled rotations and who&amp;rsquo;s currently on call.
Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token.
Keyboard Commands None.
Configuration opsgenie:enabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 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&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
Configuration opsgenie:displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false.
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
<item>
@ -172,8 +173,8 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
<description>Description Displays a configurable list of world clocks, the local time, and date.
Source Code wtf/clocks/ Required ENV Variables None.
Keyboard Commands None.
Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd Define the foreground color for the odd-numbered rows. Values: Any X11 color name.
Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.
enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item>

9
docs/posts/index.xml
View File

@ -135,8 +135,9 @@ deployCount The number of past deploys to display on screen.</description>
<description>Description Connects to the OpsGenie API and displays all your scheduled rotations and who&amp;rsquo;s currently on call.
Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token.
Keyboard Commands None.
Configuration opsgenie:enabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 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&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
Configuration opsgenie:displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false.
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
<item>
@ -172,8 +173,8 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
<description>Description Displays a configurable list of world clocks, the local time, and date.
Source Code wtf/clocks/ Required ENV Variables None.
Keyboard Commands None.
Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd Define the foreground color for the odd-numbered rows. Values: Any X11 color name.
Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.
enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item>

4
docs/posts/modules/clocks/index.html
View File

@ -148,12 +148,12 @@
<h3 id="attributes">Attributes</h3>
<p><code>colors.rows.even</code> <br />
Define the foreground color for even-numbered rows. <br />
The foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>
<p><code>colors.rows.odd</code> <br />
Define the foreground color for the odd-numbered rows. <br />
The foreground color for the odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>

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

@ -127,6 +127,7 @@ API</a> token.</p>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">opsgenie<span class="p">:</span><span class="w">
</span><span class="w"> </span>displayEmpty<span class="p">:</span><span class="w"> </span><span class="kc">false</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>top<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
@ -136,12 +137,16 @@ API</a> token.</p>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">21600</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>displayEmpty</code> <br />
Whether schedules with no assigned person on-call should be displayed. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>
Where in the grid this module&rsquo;s widget will be displayed. <br /></p>
<p><code>refreshInterval</code> <br />
How often, in seconds, this module will update its data. <br />

4
docs/posts/modules/todo/index.html
View File

@ -188,9 +188,11 @@ Values: Any displayable unicode character.</p>
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
<p><code>colors.highlight.fore</code> <br />
The foreground color for the currently-selected row. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
<p><code>colors.highlight.back</code> <br />
The background color for the currently-selected row. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
<p><code>enabled</code> <br />
@ -199,8 +201,6 @@ Values: <code>true</code>, <code>false</code>.</p>
<p><code>filename</code> <br />
The name for the todo file. <br />
<em>Note:</em> Currently this file <em>must</em> reside in the <code>~/.wtf/</code> directory.
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>. <br />
Values: Any valid filename, ideally ending in <code>yml</code>.</p>
<p><code>position</code> <br />