diff --git a/.DS_Store b/.DS_Store index f996d77e..0013b2fc 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/_site/config.toml b/_site/config.toml index 5a0b8aea..1e3e4c0e 100644 --- a/_site/config.toml +++ b/_site/config.toml @@ -3,6 +3,7 @@ languageCode = "en-us" publishDir = "../docs" sectionPagesMenu = "main" theme = "hyde-hyde" +title = "WTF" [params] author = "Chris Cummer" diff --git a/_site/content/posts/configuration.md b/_site/content/posts/configuration.md index b98573ed..d98603fb 100644 --- a/_site/content/posts/configuration.md +++ b/_site/content/posts/configuration.md @@ -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 Security, +Clocks and Status 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. diff --git a/_site/content/posts/modules.md b/_site/content/posts/modules.md index 5008592e..19d36a90 100644 --- a/_site/content/posts/modules.md +++ b/_site/content/posts/modules.md @@ -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 New Relic 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 Clocks 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: + + diff --git a/_site/content/posts/modules/bamboohr.md b/_site/content/posts/modules/bamboohr.md new file mode 100644 index 00000000..7f377ac5 --- /dev/null +++ b/_site/content/posts/modules/bamboohr.md @@ -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`
+Your BambooHR API token. + +`WTF_BAMBOO_HR_SUBDOMAIN`
+Your BambooHR API subdomain name. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +bamboohr: + enabled: true + position: + top: 0 + left: 1 + height: 2 + width: 1 + refreshInterval: 900 +``` + +### Definitions + +`enabled`
+Whether or not this module is executed and 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: Any positive integer, `0...n`. diff --git a/_site/content/posts/modules/clocks.md b/_site/content/posts/modules/clocks.md new file mode 100644 index 00000000..2d33c34e --- /dev/null +++ b/_site/content/posts/modules/clocks.md @@ -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. + +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`
+Define the text color for even-numbered rows (2, 4, 6...).
+Values: Any X11 +color name. + +`colors.odd`
+Define the text color for the odd-numbered rows (1, 3, 5...).
+Values: Any X11 +color name. + +`locations`
+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.
+Values: Any TZ database timezone. + +`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: Any positive integer, `0...n`. + +`sort`
+Defines the display order of the clocks in the widget.
+Values: `alphabetical` or `chronological`. `alphabetical` will sort in +acending order by `key`, `chronological` will sort in ascending order by +date/time. diff --git a/_site/static/imgs/modules/clocks.png b/_site/static/imgs/modules/clocks.png new file mode 100644 index 00000000..842a2db2 Binary files /dev/null and b/_site/static/imgs/modules/clocks.png differ diff --git a/_site/themes/hyde-hyde/images/main.png b/_site/themes/hyde-hyde/images/main.png deleted file mode 100644 index 7fe8d9df..00000000 Binary files a/_site/themes/hyde-hyde/images/main.png and /dev/null differ diff --git a/_site/themes/hyde-hyde/images/posts.png b/_site/themes/hyde-hyde/images/posts.png deleted file mode 100644 index b69e796a..00000000 Binary files a/_site/themes/hyde-hyde/images/posts.png and /dev/null differ diff --git a/_site/themes/hyde-hyde/images/tn.png b/_site/themes/hyde-hyde/images/tn.png deleted file mode 100644 index 55c72fde..00000000 Binary files a/_site/themes/hyde-hyde/images/tn.png and /dev/null differ diff --git a/_site/themes/hyde-hyde/layouts/index.html b/_site/themes/hyde-hyde/layouts/index.html index b6bec220..72002de3 100644 --- a/_site/themes/hyde-hyde/layouts/index.html +++ b/_site/themes/hyde-hyde/layouts/index.html @@ -3,14 +3,14 @@ {{- end }} {{ define "content" -}} -
- Star -
+ + +

- WTF is a personal information dashboard for your + WTF is a personal information dashboard for your terminal, made for those who spend most of their days in the command line.

diff --git a/_site/themes/hyde-hyde/layouts/partials/header.html b/_site/themes/hyde-hyde/layouts/partials/header.html index d049444d..8cf8d42e 100644 --- a/_site/themes/hyde-hyde/layouts/partials/header.html +++ b/_site/themes/hyde-hyde/layouts/partials/header.html @@ -9,7 +9,7 @@ {{ if .IsHome -}} {{ .Site.Title }} {{- else }} -{{ .Title }} · {{ .Site.Title }} +{{ .Title }} | {{ .Site.Title }} {{- end }} diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index 250dd1c7..8a8aea86 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -1,7 +1,7 @@