elasticsearch/docs/reference/setup
Nik Everett 4b1c116461 Generate and run tests from the docs
Adds infrastructure so `gradle :docs:check` will extract tests from
snippets in the documentation and execute the tests. This is included
in `gradle check` so it should happen on CI and during a normal build.

By default each `// AUTOSENSE` snippet creates a unique REST test. These
tests are executed in a random order and the cluster is wiped between
each one. If multiple snippets chain together into a test you can annotate
all snippets after the first with `// TEST[continued]` to have the
generated tests for both snippets joined.

Snippets marked as `// TESTRESPONSE` are checked against the response
of the last action.

See docs/README.asciidoc for lots more.

Closes #12583. That issue is about catching bugs in the docs during build.
This catches *some* bugs in the docs during build which is a good start.
2016-05-05 13:58:03 -04:00
..
install Change qoutes to quotes (#18078) 2016-05-02 13:06:07 +02:00
sysconfig Typo correction heap_size.asciidoc (#17745) 2016-04-14 20:37:37 +02:00
cluster_restart.asciidoc Generate and run tests from the docs 2016-05-05 13:58:03 -04:00
configuration.asciidoc Docs: Complete rewrite of setup, installation, and configuration docs 2016-04-03 16:09:48 +02:00
important-settings.asciidoc Docs: Complete rewrite of setup, installation, and configuration docs 2016-04-03 16:09:48 +02:00
install.asciidoc Docs: Complete rewrite of setup, installation, and configuration docs 2016-04-03 16:09:48 +02:00
rolling_upgrade.asciidoc Generate and run tests from the docs 2016-05-05 13:58:03 -04:00
sysconfig.asciidoc Docs: Complete rewrite of setup, installation, and configuration docs 2016-04-03 16:09:48 +02:00
upgrade.asciidoc Docs: Complete rewrite of setup, installation, and configuration docs 2016-04-03 16:09:48 +02:00