elasticsearch/docs/reference
Nik Everett 75342a2a71
Add teardown support for doc tests (#70831)
This adds named `teardown` support for doc tests similar to its support
for named `setup` section. This is useful when many doc files want to
share a similar `setup` AND `teardown`. I've introduced an example of
this in the CCR docs just to prove its works. We expect we'll use it for
datastreams as well.

Closes #70830

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-03-24 16:57:50 -04:00
..
aggregations Docs: Clean doc for agg parameter (#70675) 2021-03-24 16:22:26 -04:00
analysis [DOCS] Note you can omit type for custom analyzers (#70754) 2021-03-23 11:13:20 -04:00
autoscaling [DOCS] Replace put with create or update in API names (#70330) 2021-03-15 14:49:44 -04:00
cat Support include_unloaded_segments in node stats (#69682) 2021-03-01 17:18:47 +01:00
ccr Add teardown support for doc tests (#70831) 2021-03-24 16:57:50 -04:00
cluster [DOCS] HTTP client stats (#70512) 2021-03-19 06:22:17 -05:00
commands Remove support of creating CA on the fly when generating certificates (#65590) 2020-12-16 13:54:32 +11:00
data-streams [DOCS] Replace put with create or update in API names (#70330) 2021-03-15 14:49:44 -04:00
docs Clarify data replication docs to mention in-sync replicas (#70604) 2021-03-19 13:17:16 -07:00
eql [DOCS] EQL: Document Unicode escape sequences (#70694) 2021-03-23 08:10:03 -04:00
features/apis Change Get Snapshottable Features endpoint to _features (#69755) 2021-03-02 11:30:02 -07:00
graph [DOCS] Fix API titles (#67475) 2021-01-13 15:15:37 -05:00
high-availability Adjust resiliency docs for searchable snapshots (#67630) 2021-01-19 17:40:49 +00:00
how-to [DOCS] Remove performance warning for script fields (#69309) 2021-02-22 10:05:49 -05:00
ilm [DOCS] Fix heading for ILM shrink example (#70733) 2021-03-23 11:07:02 -04:00
images [DOCS] Refactor ingest pipeline docs (#70253) 2021-03-15 12:22:57 -04:00
index-modules [DOCS] Frozen tier dedicated (#70542) 2021-03-19 11:16:41 +01:00
indices Adjust the docs for template-v1 API (#70801) 2021-03-24 11:15:15 +01:00
ingest [DOCS] Add MurmurHash3 as a supported hash method for fingerprint processor (#70737) 2021-03-24 07:25:22 -05:00
licensing [DOCS] Add operator privileges to APIs and settings (#69903) 2021-03-15 09:20:09 -04:00
mapping [DOCs] Add tip for index_options parameter (#70450) (#70498) 2021-03-17 10:43:41 -04:00
migration [DOCS] Replace put with create or update in API names (#70330) 2021-03-15 14:49:44 -04:00
ml [DOCS] Updates anomaly detection alert docs with the new alerting terminology (#70486) 2021-03-18 18:23:19 +01:00
modules [DOCS] Add info about allowed profile names (#70440) (#70815) 2021-03-24 10:10:21 -04:00
monitoring [DOCS] Fix typos for duplicate words (#69125) 2021-02-17 10:34:20 -05:00
query-dsl [DOCS] Document index.query.default_field index setting (#69922) 2021-03-17 17:11:25 -04:00
release-notes [DOCS] Replace version-specific links in release highlights (#70317) (#70386) 2021-03-15 10:20:12 -04:00
repositories-metering-api [DOCS] Fix name of cluster_version parameter (#69615) 2021-03-01 08:54:47 -05:00
rest-api [DOCS] Document date math support for aliases (#70535) 2021-03-18 10:52:48 -04:00
rollup [DOCS] Add overview for rollup refactor (#70001) 2021-03-10 08:41:27 -05:00
scripting [DOCS] Focus scripting docs on Painless (#69748) 2021-03-18 15:58:33 -04:00
search Move point in time to server (#70704) 2021-03-24 14:29:20 -04:00
searchable-snapshots Note recovery settings affect searchable snapshots (#70771) 2021-03-24 09:22:44 +00:00
settings [master] docs: Add reference to reporting warning customization (#70515) (#70684) 2021-03-23 08:05:36 -05:00
setup [DOCS] Disambiguate logs and data in path settings docs (#70629) 2021-03-22 10:13:32 -04:00
slm [DOCS] Replace put with create or update in API names (#70330) 2021-03-15 14:49:44 -04:00
snapshot-restore [DOCS] Fix collapsible properties role (#70756) 2021-03-23 11:14:46 -04:00
sql SQL: Enforce and document dedicated client version compatibility (#70451) 2021-03-22 11:17:51 +01:00
tab-widgets [DOCS] Replace put with create or update in API names (#70330) 2021-03-15 14:49:44 -04:00
text-structure/apis [ML] [DOCS] update find-structure reference docs (#67586) 2021-01-15 12:19:38 -05:00
transform [DOCS] Reorganizes Transforms limitations (#70638) 2021-03-24 11:22:59 +01:00
upgrade [DOCS] Make cat API verbose query param explicit (#67300) 2021-01-11 17:19:23 -05:00
vectors [DOCS] Update my-index examples (#60132) 2020-07-27 14:46:39 -04:00
aggregations.asciidoc [DOCS] Rewrite aggs overview (#64318) 2020-10-30 08:39:38 -04:00
analysis.asciidoc [DOCS] Fix Lucene's stop words links (#70405) 2021-03-16 17:06:12 -04:00
api-conventions.asciidoc [DOCS] Document date math support for aliases (#70535) 2021-03-18 10:52:48 -04:00
cat.asciidoc Fix docs/reference/cat.asciidoc to use consistent order (#69938) 2021-03-03 16:41:16 -07:00
cluster.asciidoc [DOCS] Reword node roles docs (#69301) 2021-02-23 11:32:46 -05:00
data-management.asciidoc [DOCS] Move Kibana index mgmt docs to ES (#64380) 2020-10-30 09:14:52 -04:00
data-rollup-transform.asciidoc [DOCS] Add overview for rollup refactor (#70001) 2021-03-10 08:41:27 -05:00
datatiers.asciidoc Additional docs for shared_cache searchable snapshots (#70566) 2021-03-22 16:42:58 +01:00
dependencies-versions.asciidoc [DOCS] Added appendix to show dependencies (#67962) 2021-01-26 16:16:05 -08:00
docs.asciidoc [DOCS] Remove heading offsets for REST APIs (#44568) 2019-07-19 14:35:36 -04:00
frozen-indices.asciidoc [DOCS] Make cat API verbose query param explicit (#67300) 2021-01-11 17:19:23 -05:00
getting-started.asciidoc [DOCS] Make cat API verbose query param explicit (#67300) 2021-01-11 17:19:23 -05:00
glossary.asciidoc [DOCS] Replace external links with xrefs (#70667) 2021-03-22 12:44:05 -04:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
high-availability.asciidoc [DOCS] Add docs for designing resilient clusters (#47233) 2020-06-05 11:48:44 -04:00
how-to.asciidoc [DOCS] Fix 'How To' title (#70772) 2021-03-23 14:02:48 -04:00
index-extra-title-page.html [DOCS] Add index-extra-title-page.html for direct HTML migration (#50189) 2019-12-13 12:44:12 -05:00
index-modules.asciidoc [DOCS] Document index.query.default_field index setting (#69922) 2021-03-17 17:11:25 -04:00
index.asciidoc [DOCS] Added appendix to show dependencies (#67962) 2021-01-26 16:16:05 -08:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc [DOCS] Replace put with create or update in API names (#70330) 2021-03-15 14:49:44 -04:00
ingest.asciidoc [DOCS] Document on_failure param for create pipeline API (#70679) 2021-03-23 09:22:34 -04:00
intro.asciidoc [DOCS] Update rollup xrefs (#66799) 2020-12-23 13:49:15 -05:00
links.asciidoc [DOCS] Fix security links in machine learning APIs (#60098) 2020-07-23 12:14:56 -07:00
mapping.asciidoc Minor revision missed in merge. (#67282) 2021-01-11 13:50:06 -05:00
query-dsl.asciidoc [DOCS] Add redirects for wildcard and constant keyword (#61815) 2020-09-01 15:32:35 -04:00
redirects.asciidoc [DOCS] Focus scripting docs on Painless (#69748) 2021-03-18 15:58:33 -04:00
release-notes.asciidoc [DOCS] Adds placeholders for v8 highlights, breaking changes, release notes (#38641) 2019-02-08 15:48:42 -08:00
scripting.asciidoc [DOCS] Focus scripting docs on Painless (#69748) 2021-03-18 15:58:33 -04:00
search.asciidoc Introduce eql search status API (#68065) 2021-02-11 09:30:13 -05:00
setup.asciidoc Introduce ES_JAVA_HOME (#68954) 2021-02-17 12:41:23 -05:00
upgrade.asciidoc [DOCS] Add tip for upgrade assistant (#55027) 2020-05-05 09:49:22 -04:00