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

Simplifies the documentation pages

This commit is contained in:
Chris Cummer
2018-05-16 23:19:14 -07:00
parent e060b9799f
commit ba402358e6
34 changed files with 246 additions and 277 deletions

View File

@@ -1,11 +1,11 @@
---
title: "Attributes"
title: "Configuration: Attributes"
date: 2018-05-16T21:51:23-07:00
draft: false
---
This page describes the top-level attributes that can be added to
`config.yml`.
The following top-level attributes are configurable in `config.yml`.
See this <a href="https://github.com/senorprogrammer/wtf/blob/master/_sample_configs/simple_config.yml">example config file</a> for more details.
```yaml
wtf:

View File

@@ -1,11 +1,9 @@
---
title: "Bamboohr"
title: "Modules: Bamboohr"
date: 2018-05-07T20:17:37-07:00
draft: false
---
## Description
Connects to the BambooHR API and displays who will be Away today.
## Source Code

View File

@@ -1,11 +1,9 @@
---
title: "Clocks"
title: "Modules: 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="191" alt="clocks screenshot" />

View File

@@ -1,11 +1,9 @@
---
title: "Google Calendar"
title: "Modules: Google Calendar"
date: 2018-05-10T08:25:33-07:00
draft: false
---
## Description
Displays your upcoming Google calendar events.
<img src="/imgs/modules/gcal.png" width="320" height="389" alt="gcal screenshot" />

View File

@@ -1,11 +1,9 @@
---
title: "Git"
title: "Modules: Git"
date: 2018-05-09T14:20:48-07:00
draft: false
---
## Description
Displays information about local git repositories: branch, changed
files, and recent commits.

View File

@@ -1,11 +1,9 @@
---
title: "Github"
title: "Modules: Github"
date: 2018-05-09T19:20:20-07:00
draft: false
---
## Description
Displays information about git repositories hosted on Github: open
review requests, and open pull requests.

View File

@@ -1,11 +1,9 @@
---
title: "Jira"
title: "Modules: Jira"
date: 2018-05-10T10:44:35-07:00
draft: false
---
## Description
Displays all Jira issues assigned to you for the specified project.
<img src="/imgs/modules/jira.png" width="640" height="188" alt="jira screenshot" />

View File

@@ -1,11 +1,9 @@
---
title: "Newrelic"
title: "Modules: New Relic"
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.

View File

@@ -1,11 +1,9 @@
---
title: "Opsgenie"
title: "Modules: OpsGenie"
date: 2018-05-08T20:53:40-07:00
draft: false
---
## Description
Connects to the OpsGenie API and displays all your scheduled rotations
and who's currently on call.

View File

@@ -1,11 +1,9 @@
---
title: "Security"
title: "Modules: Security"
date: 2018-05-08T20:33:28-07:00
draft: false
---
## Description
Displays some general information about the state of the machine's wifi
connection, firewall, and DNS settings.

View File

@@ -1,11 +1,9 @@
---
title: "Textfile"
title: "Modules: 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" />

View File

@@ -1,11 +1,9 @@
---
title: "Todo"
title: "Modules: Todo"
date: 2018-05-10T12:41:50-07:00
draft: false
---
## Description
An interactive todo list.
<img src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" />

View File

@@ -1,11 +1,9 @@
---
title: "Weather"
title: "Modules: Weather"
date: 2018-05-09T11:44:13-07:00
draft: false
---
## Description
Displays a configurable list of current weather report, including
current temperature, sunrise time, and sunset time.