From f173c2f1c29f926e1fcfa3d10f3a69a85039ae25 Mon Sep 17 00:00:00 2001
From: Jose Diaz-Gonzalez <email@josediazgonzalez.com>
Date: Sun, 29 Jul 2018 19:30:45 -0400
Subject: [PATCH] docs: add missing documentation for scheduler-failed plugin
 trigger

---
 .../advanced-usage/schedulers/docker-local.md |  3 ++-
 docs/development/plugin-triggers.md           | 19 +++++++++++++++++++
 2 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/docs/advanced-usage/schedulers/docker-local.md b/docs/advanced-usage/schedulers/docker-local.md
index 1427a0a97..28342344b 100644
--- a/docs/advanced-usage/schedulers/docker-local.md
+++ b/docs/advanced-usage/schedulers/docker-local.md
@@ -25,7 +25,8 @@ This plugin implements various functionality through `plugn` triggers to integra
 - `pre-restore`
 - `scheduler-deploy`
 - `scheduler-docker-cleanup`
+- `scheduler-failed`
 - `scheduler-run`
 - `scheduler-stop`
 - `scheduler-tags-create`
-- `scheduler-tags-destroy`
\ No newline at end of file
+- `scheduler-tags-destroy`
diff --git a/docs/development/plugin-triggers.md b/docs/development/plugin-triggers.md
index a14bea974..f5533c1f7 100644
--- a/docs/development/plugin-triggers.md
+++ b/docs/development/plugin-triggers.md
@@ -1207,6 +1207,25 @@ DOKKU_SCHEDULER="$1"; APP="$2"; FORCE_CLEANUP="$3";
 # TODO
 ```
 
+### `scheduler-failed`
+
+> Warning: The scheduler plugin trigger apis are under development and may change
+> between minor releases until the 1.0 release.
+
+- Description: Allows you to run scheduler commands when retrieving failed container logs
+- Invoked by: `dokku logs:failed`
+- Arguments: `$DOKKU_SCHEDULER $APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+DOKKU_SCHEDULER="$1"; APP="$2"; ARGS="${@:3}";
+
+# TODO
+```
+
 ### `scheduler-run`
 
 - Description: Allows you to run scheduler commands when a command is executed for your app