From 93e8078a939cce7ae5350ab79e2a634f4f44b2c1 Mon Sep 17 00:00:00 2001 From: Trevor Turk Date: Thu, 3 Mar 2016 11:29:40 -0600 Subject: [PATCH] Checks doc: break CHECKS file explanation into bullet points for easier reading --- docs/checks-examples.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/checks-examples.md b/docs/checks-examples.md index aebe9822f..309d59543 100644 --- a/docs/checks-examples.md +++ b/docs/checks-examples.md @@ -32,7 +32,14 @@ dokku config:set DOKKU_WAIT_TO_RETIRE=120 If your application needs a longer period to boot up - perhaps to load data into memory, or because of slow boot time - you may also use dokku's `checks` functionality to more precisely check whether an application can serve traffic or not. -To specify checks, add a `CHECKS` file to the root of your project directory. The `CHECKS` file may contain empty lines, comments (lines starting with #), settings (NAME=VALUE), and check instructions. The format of a check instruction is a path or relative URL, optionally followed by the expected content. For example: +To specify checks, add a `CHECKS` file to the root of your project directory. The `CHECKS` file should be plain text and may contain: + + * empty lines + * comments (lines starting with #) + * settings (NAME=VALUE) + * check instructions + +The format of a check instruction is a path or relative URL, optionally followed by the expected content. For example: ``` /about Our Amazing Team