Skip to content

Commit a9d5a09

Browse files
committed
[DOCS] Update readme for testing x-pack code snippets (#30696)
1 parent c3dd27e commit a9d5a09

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,14 @@ Before submitting your changes, run the test suite to make sure that nothing is
175175
./gradlew check
176176
```
177177

178+
If your changes affect only the documentation, run:
179+
180+
```sh
181+
./gradlew -p docs check
182+
```
183+
For more information about testing code examples in the documentation, see
184+
https://github.com/elastic/elasticsearch/blob/master/docs/README.asciidoc
185+
178186
### Project layout
179187

180188
This repository is split into many top level directories. The most important

docs/README.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ CONSOLE" and "COPY AS CURL" in the documentation and are automatically tested
88
by the command `gradle :docs:check`. To test just the docs from a single page,
99
use e.g. `gradle :docs:check -Dtests.method=*rollover*`.
1010

11+
NOTE: If you have an elasticsearch-extra folder alongside your elasticsearch
12+
folder, you must temporarily rename it when you are testing 6.3 or later branches.
13+
1114
By default each `// CONSOLE` snippet runs as its own isolated test. You can
1215
manipulate the test execution in the following ways:
1316

0 commit comments

Comments
 (0)