From 36d607a4f4ba5f69ddac35b3bd09e5ed49962a93 Mon Sep 17 00:00:00 2001 From: Michael Hobbs Date: Tue, 7 Jul 2015 16:33:13 -0700 Subject: [PATCH] [ci skip] update docs --- docs/development/plugin-creation.md | 6 +++--- docs/development/pluginhooks.md | 4 ++-- plugins/docker-options/commands | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/development/plugin-creation.md b/docs/development/plugin-creation.md index 236f0f4a1..f56b11b74 100644 --- a/docs/development/plugin-creation.md +++ b/docs/development/plugin-creation.md @@ -32,8 +32,8 @@ case "$1" in help) cat && cat< Says "Hello " - hello:world Says "Hello world" + hello , Says "Hello " + hello:world, Says "Hello world" EOF ;; @@ -48,7 +48,7 @@ A few notes: - You should always support `DOKKU_TRACE` as specified on the 2nd line of the plugin. - If your command requires that an application exists, ensure you check for it's existence in the manner prescribed above. -- A `help` command is required, though it is allowed to be empty. +- A `help` command is required, though it is allowed to be empty. Also, the command syntax will need to separated by `, ` in order to maintain columnar output alignment. - Commands *should* be namespaced. - As of 0.3.3, a catch-all should be implemented which exits with a `DOKKU_NOT_IMPLEMENTED_EXIT` code. This allows dokku to output a `command not found` message. - Be sure you want the "set -eo pipefail" option. Look at the following example : diff --git a/docs/development/pluginhooks.md b/docs/development/pluginhooks.md index 78e464d4d..00d803b1a 100644 --- a/docs/development/pluginhooks.md +++ b/docs/development/pluginhooks.md @@ -107,8 +107,8 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x case "$1" in help | derp:help) cat && cat<, Display apps docker options for all phases - docker-options , Display apps docker options for phase (comma seperated phase list) - docker-options:add OPTION, Add docker option to app for phase (comma seperated phase list) - docker-options:remove OPTION, Remove docker option from app for phase (comma seperated phase list) + docker-options , Display apps docker options for phase (comma separated phase list) + docker-options:add OPTION, Add docker option to app for phase (comma separated phase list) + docker-options:remove OPTION, Remove docker option from app for phase (comma separated phase list) EOF ;;