Mirrors/dokku
1
0
Fork 0
mirror of https://github.com/dokku/dokku.git synced 2026-02-23 19:50:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

[ci skip] update docs

Browse Source
This commit is contained in:
Michael Hobbs
2015-07-07 16:33:13 -07:00
parent b30db17def
commit 36d607a4f4
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/development/plugin-creation.md
View File

@@ -32,8 +32,8 @@ case "$1" in
help)
cat && cat<<EOF
hello <app> Says "Hello <app>"
hello:world Says "Hello world"
hello <app>, Says "Hello <app>"
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 :

4
docs/development/pluginhooks.md
View File

@@ -107,8 +107,8 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
case "$1" in
help | derp:help)
cat && cat<<EOF
derp:herp Herps the derp
derp:serp [file] Shows the file's serp
derp:herp, Herps the derp
derp:serp [file], Shows the file's serp
EOF
;;

6
plugins/docker-options/commands
View File

@@ -142,9 +142,9 @@ case "$1" in
help)
cat && cat<<EOF
docker-options <app>, Display apps docker options for all phases
docker-options <app> <phase(s)>, Display apps docker options for phase (comma seperated phase list)
docker-options:add <app> <phase(s)> OPTION, Add docker option to app for phase (comma seperated phase list)
docker-options:remove <app> <phase(s)> OPTION, Remove docker option from app for phase (comma seperated phase list)
docker-options <app> <phase(s)>, Display apps docker options for phase (comma separated phase list)
docker-options:add <app> <phase(s)> OPTION, Add docker option to app for phase (comma separated phase list)
docker-options:remove <app> <phase(s)> OPTION, Remove docker option from app for phase (comma separated phase list)
EOF
;;