Skip to content

Commit

Permalink
[DOCS] Updates documentation tests in contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed May 30, 2018
1 parent 2cfcf0e commit 2c7c834
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/README.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 2c7c834

Please sign in to comment.