github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Trevor Turk
2016-03-03 11:22:39 -06:00
parent aeaf12a7a2
commit 405c23f2bd
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/checks-examples.md
View File

@@ -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. 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: A check is a relative URL and may be followed by expected content from the page, for example:
``` ```
/about Our Amazing Team /about Our Amazing Team
``` ```
The CHECKS file may contain empty lines, comments (lines starting with #), The `CHECKS` file can contain multiple checks, for example:
settings (NAME=VALUE) and check instructions.
The format of a check instruction is a path, optionally followed by the
expected content. For example:
``` ```
/ My Amazing App / My Amazing App