diff --git a/_site/content/posts/modules/clocks.md b/_site/content/posts/modules/clocks.md index 0c0f702b..9a7534c4 100644 --- a/_site/content/posts/modules/clocks.md +++ b/_site/content/posts/modules/clocks.md @@ -53,12 +53,12 @@ clocks: ### Attributes `colors.rows.even`
-Define the foreground color for even-numbered rows.
+The foreground color for even-numbered rows.
Values: Any X11 color name. `colors.rows.odd`
-Define the foreground color for the odd-numbered rows.
+The foreground color for the odd-numbered rows.
Values: Any X11 color name. diff --git a/_site/content/posts/modules/opsgenie.md b/_site/content/posts/modules/opsgenie.md index 09293426..84a81a56 100644 --- a/_site/content/posts/modules/opsgenie.md +++ b/_site/content/posts/modules/opsgenie.md @@ -31,6 +31,7 @@ None. ```yaml opsgenie: + displayEmpty: false enabled: true position: top: 2 @@ -42,12 +43,16 @@ opsgenie: ### Attributes +`displayEmpty`
+Whether schedules with no assigned person on-call should be displayed.
+Values: `true`, `false`. + `enabled`
-Determines whether or not this module is executed and if its data displayed onscreen.
+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.
+Where in the grid this module's widget will be displayed.
`refreshInterval`
How often, in seconds, this module will update its data.
diff --git a/_site/content/posts/modules/todo.md b/_site/content/posts/modules/todo.md index fb9231c4..a703e960 100644 --- a/_site/content/posts/modules/todo.md +++ b/_site/content/posts/modules/todo.md @@ -94,9 +94,11 @@ Values: Any displayable unicode character. Values: Any X11 color name. `colors.highlight.fore`
+The foreground color for the currently-selected row.
Values: Any X11 color name. `colors.highlight.back`
+The background color for the currently-selected row.
Values: Any X11 color name. `enabled`
@@ -105,8 +107,6 @@ Values: `true`, `false`. `filename`
The name for the todo file.
-*Note:* Currently this file *must* reside in the `~/.wtf/` directory. -This is a known bug.
Values: Any valid filename, ideally ending in `yml`. `position`
diff --git a/docs/index.xml b/docs/index.xml index ed3dd24d..77b38673 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -135,8 +135,9 @@ deployCount The number of past deploys to display on screen. Description Connects to the OpsGenie API and displays all your scheduled rotations and who’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’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. +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’s widget will be displayed. @@ -172,8 +173,8 @@ position Defines where in the grid this module’s widget will be displa 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:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" 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:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" 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. diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 85d7b3c7..3c967df0 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -135,8 +135,9 @@ deployCount The number of past deploys to display on screen. Description Connects to the OpsGenie API and displays all your scheduled rotations and who’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’s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. +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’s widget will be displayed. @@ -172,8 +173,8 @@ position Defines where in the grid this module’s widget will be displa 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:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" 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:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" 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. diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index 6ec3c525..eccdfd48 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -148,12 +148,12 @@

Attributes

colors.rows.even
-Define the foreground color for even-numbered rows.
+The foreground color for even-numbered rows.
Values: Any X11 color name.

colors.rows.odd
-Define the foreground color for the odd-numbered rows.
+The foreground color for the odd-numbered rows.
Values: Any X11 color name.

diff --git a/docs/posts/modules/opsgenie/index.html b/docs/posts/modules/opsgenie/index.html index b161656f..cf593a30 100644 --- a/docs/posts/modules/opsgenie/index.html +++ b/docs/posts/modules/opsgenie/index.html @@ -127,6 +127,7 @@ API token.

Configuration

opsgenie:
+  displayEmpty: false
   enabled: true
   position:
     top: 2
@@ -136,12 +137,16 @@ API token.

   refreshInterval: 21600

Attributes

+

displayEmpty
+Whether schedules with no assigned person on-call should be displayed.
+Values: true, false.

+

enabled
-Determines whether or not this module is executed and if its data displayed onscreen.
+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.

+Where in the grid this module’s widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
diff --git a/docs/posts/modules/todo/index.html b/docs/posts/modules/todo/index.html index 8c8df017..01fbe33c 100644 --- a/docs/posts/modules/todo/index.html +++ b/docs/posts/modules/todo/index.html @@ -188,9 +188,11 @@ Values: Any displayable unicode character.

Values: Any X11 color name.

colors.highlight.fore
+The foreground color for the currently-selected row.
Values: Any X11 color name.

colors.highlight.back
+The background color for the currently-selected row.
Values: Any X11 color name.

enabled
@@ -199,8 +201,6 @@ Values: true, false.

filename
The name for the todo file.
-Note: Currently this file must reside in the ~/.wtf/ directory. -This is a known bug.
Values: Any valid filename, ideally ending in yml.

position