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

Build of the site

This commit is contained in:
Chris Cummer
2018-05-08 20:24:31 -07:00
parent b55ca47678
commit 7edc5f8339
37 changed files with 1093 additions and 195 deletions

View File

@@ -3,6 +3,7 @@ languageCode = "en-us"
publishDir = "../docs"
sectionPagesMenu = "main"
theme = "hyde-hyde"
title = "WTF"
[params]
author = "Chris Cummer"

View File

@@ -5,32 +5,32 @@ draft: false
---
By default WTF looks in a `~/.wtf/` directory for a YAML file called
`config.yml`. If `~/.wtf/` doesn't exist, WTF will create that directory
on start-up, and then display instructions for creating the
`config.yml`. If the `~/.wtf/` directory doesn't exist, WTF will create that directory
on start-up, and then display instructions for creating a new
configuration file.
## Config.yml
In other words, WTF expects to have a YAML config file at: `~/.wtf/config.yml`.
## Example Config Files
## Example Configuration Files
A few example config files are provided in the `_sample_configs/`
directory of the Git repository. To try out WTF quickly, copy
A couple of example config files are provided in the `_sample_configs/`
directory of the Git repository.
To try out WTF quickly, copy
`simple_config.yml` into `~/.wtf/` as `config.yml` and relaunch WTF. You
should see the app launch and display the _Security_ and _Status_
modules.
should see the app launch and display the <a href="/posts/modules/security/">Security</a>,
<a href="/posts/modules/clocks/">Clocks</a> and <a href="/posts/modules/status/">Status</a> widgets onscreen.
## Custom Configuration Files
To try out different configurations (or run multiple instances of WTF),
you can pass the path to a config file via command line arguments on
start-up.
To load a custom configuration file (ie: one that's not
`~/.wtf/config.yml`), pass in the path to configuration file as a
parameter on launch:
```bash
$> wtf --config=path/to/custom/config.yml
```
Example:
```bash
%> wtf --config=~/Documents/monitoring.yml
```
This is also the easiest way to run multiple instances of WTF, should
you want to run multiple independent dashboards.

View File

@@ -1,7 +1,35 @@
---
title: "Modules"
date: 2018-05-07T18:04:58-07:00
draft: true
draft: false
---
The heart of WTF is the modules. A module is a discreet unit of
functionality that extracts data from some source and packages that data
for display.
For example, the <a href="/posts/modules/newrelic">New Relic</a> module
uses New Relic's API to retrieve a list of the latest deploys and
packages that information as a list for display in the "New Relic"
widget.
The <a href="/posts/modules/clocks">Clocks</a> module takes a list of
timezones and packages that information as a list of city/time pairs for
display in the "Clocks" widget.
Available modules:
<ul class="list-bare">
<li><a href="/posts/modules/bamboohr">BambooHR</a>
<li><a href="/posts/modules/clocks">Clocks</a>
<li><a href="/posts/modules/git">Git</a>
<li><a href="/posts/modules/github">Github</a>
<li><a href="/posts/modules/gcal">Google Calendar</a>
<li><a href="/posts/modules/jira">Jira</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">Text Files</a>
<li><a href="/posts/modules/todo">Todo</a>
<li><a href="/posts/modules/weather">Weather</a>
</ul>

View File

@@ -0,0 +1,53 @@
---
title: "Bamboohr"
date: 2018-05-07T20:17:37-07:00
draft: false
---
## Description
Connects to the BambooHR API and displays who will be Away today.
## Location
```bash
wtf/bamboohr
```
## Required ENV Variables
`WTF_BAMBOO_HR_TOKEN` <br />
Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.
`WTF_BAMBOO_HR_SUBDOMAIN` <br />
Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.
## Keyboard Commands
None.
## Configuration
```yaml
bamboohr:
enabled: true
position:
top: 0
left: 1
height: 2
width: 1
refreshInterval: 900
```
### Definitions
`enabled` <br />
Whether or not this module is executed and 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: Any positive integer, `0...n`.

View File

@@ -0,0 +1,82 @@
---
title: "Clocks"
date: 2018-05-07T19:47:31-07:00
draft: false
---
## Description
Displays a configurable list of world clocks, the local time, and date.
<img src="/imgs/modules/clocks.png" width="320" height="180" alt="clocks screenshot" />
## Location
```bash
wtf/clocks/
```
## Required ENV Variables
None.
## Keyboard Commands
None.
## Configuration
```yaml
clocks:
colors:
rows:
even: "lightblue"
odd: "white"
enabled: true
locations:
# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Avignon: "Europe/Paris"
Barcelona: "Europe/Madrid"
Dubai: "Asia/Dubai"
UTC: "Etc/UTC"
Vancouver: "America/Vancouver"
Toronto: "America/Toronto"
position:
top: 4
left: 0
height: 1
width: 1
refreshInterval: 15
# Valid options are: alphabetical, chronological
sort: "alphabetical"
```
### Definitions
`colors.even` <br />
Define the text color for even-numbered rows (2, 4, 6...). <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`colors.odd` <br />
Define the text color for the odd-numbered rows (1, 3, 5...). <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`locations` <br />
Defines the timezones for the world clocks that you want to display.
`key` is a unique label that will be displayed in the UI. `value` is a
timezone name. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">TZ database timezone</a>.
`position` <br />
Defines where in the grid this module's widget will be displayed.
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: Any positive integer, `0...n`.
`sort` <br />
Defines the display order of the clocks in the widget. <br />
Values: `alphabetical` or `chronological`. `alphabetical` will sort in
acending order by `key`, `chronological` will sort in ascending order by
date/time.

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 317 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 179 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 204 KiB

View File

@@ -3,14 +3,14 @@
{{- end }}
{{ define "content" -}}
<div style="float: right;">
<a class="github-button" href="https://github.com/senorprogrammer/wtf" data-show-count="true" aria-label="Star senorprogrammer/wtf on GitHub">Star</a>
</div>
<!--<div style="float: right;">-->
<!--<a class="github-button" href="https://github.com/senorprogrammer/wtf" data-show-count="true" aria-label="Star senorprogrammer/wtf on GitHub">Star</a>-->
<!--</div>-->
<a href="/img/screenshot.png" target="_screenshot"><img src='/img/screenshot_sm.png' /></a>
<p>
<span style="font-family: monospace; font-size: 1.5em;">WTF</span> is a personal information dashboard for your
<span style="font-family: monospace; font-size: 1.6em;">WTF</span> is a personal information dashboard for your
terminal, made for those who spend most of their days in the command line.
</p>

View File

@@ -9,7 +9,7 @@
{{ if .IsHome -}}
<title>{{ .Site.Title }}</title>
{{- else }}
<title>{{ .Title }} &middot; {{ .Site.Title }}</title>
<title>{{ .Title }} | {{ .Site.Title }}</title>
{{- end }}
<meta content="{{ $isHomePage := eq .Title .Site.Title }}{{ .Title }}{{ if eq $isHomePage false }} - {{ .Site.Title }}{{ end }}" property="og:title">
<meta content="{{ $isHomePage := eq .Title .Site.Title }}{{ .Site.Params.meta.description }}{{ if eq $isHomePage false }} - {{ .Description }}{{ end }}" property="og:description">

View File

@@ -1,7 +1,7 @@
<div class="sidebar">
<div class="container sidebar-sticky">
<div class="sidebar-about text-center">
<a href="{{ .Site.BaseURL }}"><h1 class="brand">{{ .Site.Title }}</h1></a>
<!--<a href="{{ .Site.BaseURL }}"><h1 class="brand">{{ .Site.Title }}</h1></a>-->
<a href="{{ .Site.BaseURL }}">{{ with .Site.Params.authorimage }} <img src="{{.}}" alt="WFT Logo" class="" width=""> {{ end }}</a>
<p class="lead">
{{ with .Site.Params.description }} {{.}} {{ else }} {{end}}
@@ -19,24 +19,20 @@
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/source/">Source Code</a></li>
</ul>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr">BambooHR</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks">Clocks</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/git">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather">Weather</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/git/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul>
</div>

View File

@@ -52,12 +52,15 @@ pre
pre code, li code, td code, code
{
border-radius: 4px;
/*border-radius: 4px;*/
white-space: pre-wrap;
padding:1px 4px;
background: #eee;
background-color: white;
margin: 0 !important;
padding: 0;
/*padding:1px 4px;*/
/*background: #eee;*/
/* color: #444; */
border: 1px solid #d9d9d9;
/*border: 1px solid #d9d9d9;*/
}
code {
@@ -81,4 +84,4 @@ code {
/* Changing from font-awesome 4 to 5, the class pull-right was removed */
.pull-right {
float: right;
}
}

View File

@@ -150,11 +150,11 @@ pre {
font-family: Menlo, Monaco, "Courier New", monospace;
}
code {
padding: .25em .5em;
/*padding: .25em .5em;*/
font-size: 85%;
color: #bf616a;
background-color: #f9f9f9;
border-radius: 3px;
/*background-color: #f9f9f9;*/
/*border-radius: 3px;*/
}
pre {
display: block;
@@ -173,7 +173,7 @@ pre code {
padding: 0;
font-size: 100%;
color: inherit;
background-color: transparent;
/*background-color: transparent;*/
}
.highlight {
margin-bottom: 1rem;

View File

@@ -1,3 +1,27 @@
h1, h2, h3 {
letter-spacing: 0.25px;
}
h2 {
margin-top: 24px;
}
p {
font-size: 16px;
}
pre code {
padding-left: 8px !important;
}
.list-bare {
list-style-type: none;
}
.list-bare li {
margin: 2px 0 0 12px;
}
.sidebar-list-item-1 {
font-size: 0.9em;
margin: 0 0 0 12px;