Skip to content

Commit

Permalink
Site cosmetics and docs (#491)
Browse files Browse the repository at this point in the history
Site cosmetics and docs
  • Loading branch information
Victor Castell authored Feb 4, 2019
1 parent 90edc5d commit 0630a90
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 11 deletions.
34 changes: 34 additions & 0 deletions website/content/pro/processors/slack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Slack processor
---

The Slack processor provides slack notifications with multiple configurations and rich format.

Configuration of the slack processor is stored in a file named `dkron-processor-slack.yml` in the same locations as `dkron.yml`, and should include a list of teams, it can include any number of teams.

![](/img/slack.png)

Example:
```yaml
team1:
webhook_url: https://hooks.slack.com/services/XXXXXXXXXXXXXXXXXXX
bot_name: Dkron Production
```
Then configure each job with the following options:
Example:
```json
{
"processors": {
"slack": {
"team": "team1",
"channel": "#cron-production",
"onSuccess": true
}
}
}
```

By default the slack procesor doesn't send notifications on job success, the `onSuccess` parameter, enables it, like in the previous example.
22 changes: 15 additions & 7 deletions website/layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
<div id="jumbotron">
<div class="container">
<div class="text-wrapper">
<h2>Job scheduling made easy, distributed and highly-available</h2>
<h2>Easy, Reliable Cron jobs</h2>
<h3>A distributed Cron service with API and easy to use dashboard.</h3>
<a href="https://github.com/victorcoder/dkron/releases" class="button button-light">Download</a>
<a href="/products/pro/" class="button button-light">Go Pro</a>
</div>
<div class="dkron-logo"><img src="../img/dkron-jumbo-logo-white.png"></div>
<div class="dkron-logo"><img src="../img/job-list.png"></div>
</div>
</div>
</div>
Expand Down Expand Up @@ -169,35 +170,42 @@ <h3><a href="/products/pro/">Pro</a></h3>
</tr>
<tr>
<td class="key">
<a href="{{"usage/metrics/" | relURL}}">Historial Metrics</a>
<a href="{{"usage/metrics/" | relURL}}">Metrics</a>
</td>
<td><span class="glyphicon glyphicon-ok-sign text-success"></span></td>
<td><span class="glyphicon glyphicon-ok-sign text-success"></span></td>
</tr>
<tr>
<td class="key">
<a href="{{"pro/docker/" | relURL}}">Docker executor</a>
<a href="{{"pro/executors/docker/" | relURL}}">Docker executor</a>
</td>
<td><span class="glyphicon glyphicon-minus-sign text-danger"></span></td>
<td><span class="glyphicon glyphicon-ok-sign text-success"></span></td>
</tr>
<tr>
<td class="key">
<a href="{{"pro/ecs/" | relURL}}">AWS ECS executor</a>
<a href="{{"pro/executors/ecs/" | relURL}}">AWS ECS executor</a>
</td>
<td><span class="glyphicon glyphicon-minus-sign text-danger"></span></td>
<td><span class="glyphicon glyphicon-ok-sign text-success"></span></td>
</tr>
<tr>
<td class="key">
<a href="{{"pro/elasticsearch/" | relURL}}">Elasticsearch processor</a>
<a href="{{"pro/processors/elasticsearch/" | relURL}}">Elasticsearch processor</a>
</td>
<td><span class="glyphicon glyphicon-minus-sign text-danger"></span></td>
<td><span class="glyphicon glyphicon-ok-sign text-success"></span></td>
</tr>
<tr>
<td class="key">
<a href="{{"pro/email/" | relURL}}">Advanced Email processor</a>
<a href="{{"pro/processors/email/" | relURL}}">Advanced Email processor</a>
</td>
<td><span class="glyphicon glyphicon-minus-sign text-danger"></span></td>
<td><span class="glyphicon glyphicon-ok-sign text-success"></span></td>
</tr>
<tr>
<td class="key">
<a href="{{"pro/processors/slack/" | relURL}}">Slack processor</a>
</td>
<td><span class="glyphicon glyphicon-minus-sign text-danger"></span></td>
<td><span class="glyphicon glyphicon-ok-sign text-success"></span></td>
Expand Down
8 changes: 4 additions & 4 deletions website/static/css/app.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added website/static/img/job-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/static/img/slack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0630a90

Please sign in to comment.