From 2c7c834bac5ea07c489ba306ca4cd350f5b8b968 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 30 May 2018 14:26:20 -0700 Subject: [PATCH] [DOCS] Updates documentation tests in contributing.md --- CONTRIBUTING.md | 8 ++++++++ docs/README.asciidoc | 1 - 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1f78910e9a4d..b8f4262ca5ce8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -209,6 +209,14 @@ Before submitting your changes, run the test suite to make sure that nothing is ./gradlew check ``` +If your changes affect only the documentation, run: + +```sh +./gradlew -p docs check +``` +For more information about testing code examples in the documentation, see +https://github.com/elastic/elasticsearch/blob/master/docs/README.asciidoc + ### Project layout This repository is split into many top level directories. The most important diff --git a/docs/README.asciidoc b/docs/README.asciidoc index f78cf8b86b4d8..766aeae0c5d94 100644 --- a/docs/README.asciidoc +++ b/docs/README.asciidoc @@ -7,7 +7,6 @@ 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.