Skip to content

Commit

Permalink
Update readme for testing x-pack code snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored May 17, 2018
1 parent 663295d commit 91efecc
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/README.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Snippets marked with `// CONSOLE` are automatically annotated with "VIEW IN
CONSOLE" and "COPY AS CURL" in the documentation and are automatically tested
by the command `gradle :docs:check`. To test just the docs from a single page,
use e.g. `gradle :docs:check -Dtests.method="\*rollover*"`.
To test the docs in the x-pack folder, use the command `./gradlew -p x-pack/docs check`.

NOTE: If you have an elasticsearch-extra folder alongside your elasticsearch folder, you must temporarily rename it when you are testing 6.3 or later branches.

By default each `// CONSOLE` snippet runs as its own isolated test. You can
manipulate the test execution in the following ways:
Expand Down

0 comments on commit 91efecc

Please sign in to comment.