From 405c23f2bdf511b4fd2aa1e7085f9d9879014bf5 Mon Sep 17 00:00:00 2001 From: Trevor Turk Date: Thu, 3 Mar 2016 11:22:39 -0600 Subject: [PATCH] Checks doc: move redundant content to the same spot for now, add a bit of content to divide the single check and multi check examples --- docs/checks-examples.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/checks-examples.md b/docs/checks-examples.md index d27917245..234a2de13 100644 --- a/docs/checks-examples.md +++ b/docs/checks-examples.md @@ -34,17 +34,19 @@ If your application needs a longer period to boot up - perhaps to load data into To specify checks, add a `CHECKS` file to the root of your project directory. This is a text file with one line per check. Empty lines and lines starting with `#` are ignored. +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, optionally followed by the +expected content. For example: + A check is a relative URL and may be followed by expected content from the page, for example: ``` /about Our Amazing Team ``` -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, optionally followed by the -expected content. For example: +The `CHECKS` file can contain multiple checks, for example: ``` / My Amazing App