elasticsearch/docs/reference
Nik Everett ecca7617ed
Add teardown support for doc tests (backport of #70831) (#70843)
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>

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-03-25 16:28:51 -04:00
..
aggregations Docs: Clean doc for agg parameter (backport of #70675) (#70841) 2021-03-24 16:38:44 -04:00
analysis [DOCS] Note you can omit type for custom analyzers (#70754) (#70760) 2021-03-23 13:43:40 -04:00
autoscaling [DOCS] Replace hard-coded admons with cloud-only attribute (#70864) (#70868) 2021-03-25 10:03:13 -04:00
cat Support include_unloaded_segments in node stats (#69682) (#69721) 2021-03-02 08:38:52 +01:00
ccr Add teardown support for doc tests (backport of #70831) (#70843) 2021-03-25 16:28:51 -04:00
cluster [DOCS] Add operator privileges to APIs and settings (#69903) (#70389) 2021-03-15 10:22:00 -04:00
commands [DOCS] [7.x] Overhaul TLS security docs (#68946) (#70880) 2021-03-25 14:07:27 -04:00
data-streams [DOCS] Replace put with create or update in API names (#70330) (#70421) 2021-03-15 17:16:13 -04:00
docs Clarify data replication docs to mention in-sync replicas (#70604) 2021-03-19 20:58:29 +00:00
eql [DOCS] EQL: Use data streams in docs (#70822) (#70873) 2021-03-25 10:02:45 -04:00
features/apis Change Get Snapshottable Features endpoint to _features (#69755) 2021-03-02 15:33:40 -07:00
graph [DOCS] Fix API titles (#67475) (#67480) 2021-01-13 15:56:17 -05:00
high-availability Adjust resiliency docs for searchable snapshots (#67630) 2021-01-19 17:41:12 +00:00
how-to [DOCS] Remove performance warning for script fields (#69309) (#69354) 2021-02-22 10:20:33 -05:00
ilm [DOCS] Fix heading for ILM shrink example (#70733) (#70757) 2021-03-23 13:43:23 -04:00
images [DOCS] Refactor ingest pipeline docs (#70253) (#70409) 2021-03-15 14:12:11 -04:00
index-modules [DOCS] Frozen tier dedicated (#70542) (#70598) 2021-03-19 14:31:45 +01:00
indices Adjust the docs for template-v1 API (#70802) 2021-03-24 11:17:54 +01:00
ingest [DOCS] Move enrich policy object def to API docs (#70825) (#70866) 2021-03-25 09:32:29 -04:00
licensing [DOCS] [7.x] Overhaul TLS security docs (#68946) (#70880) 2021-03-25 14:07:27 -04:00
mapping Change default format for date_nanos field (#70463) (#70488) 2021-03-18 16:31:52 +01:00
migration [DOCS] List indices.query.bool.max_clause_count as static cluster setting (#70810) (#70813) 2021-03-24 09:24:27 -04:00
ml [DOCS] Updates anomaly detection alert docs with the new alerting terminology (#70486) (#70576) 2021-03-22 14:24:23 +01:00
modules [DOCS] [7.x] Overhaul TLS security docs (#68946) (#70880) 2021-03-25 14:07:27 -04:00
monitoring [DOCS] [7.x] Overhaul TLS security docs (#68946) (#70880) 2021-03-25 14:07:27 -04:00
query-dsl [DOCS] Document index.query.default_field index setting (#69922) (#70528) 2021-03-17 17:35:08 -04:00
release-notes [DOCS] Re-add coming tag to release highlights 2021-03-23 09:44:32 -04:00
repositories-metering-api [DOCS] Fix name of cluster_version parameter (#69615) (#69700) 2021-03-01 09:15:27 -05:00
rest-api [DOCS] Move enrich policy object def to API docs (#70825) (#70866) 2021-03-25 09:32:29 -04:00
rollup [DOCS] Add overview for rollup refactor (#70001) (#70233) 2021-03-10 09:03:56 -05:00
scripting [DOCS] [7.x] Focus scripting docs on Painless (#69748) (#70588) 2021-03-18 17:33:44 -04:00
search [DOCS] Clarify language for supported APIs with CCS and older clusters (#70734) (#70881) 2021-03-25 14:08:08 -04:00
searchable-snapshots Note recovery settings affect searchable snapshots (#70771) 2021-03-24 09:23:04 +00:00
settings [7.x] docs: Add reference to reporting warning customization (#70515) (#70686) 2021-03-23 08:06:02 -05:00
setup [DOCS] [7.x] Overhaul TLS security docs (#68946) (#70880) 2021-03-25 14:07:27 -04:00
slm [DOCS] Replace put with create or update in API names (#70330) (#70421) 2021-03-15 17:16:13 -04:00
snapshot-restore [DOCS] Fix collapsible properties role (#70756) (#70762) 2021-03-23 13:43:57 -04:00
sql [DOCS] [7.x] Overhaul TLS security docs (#68946) (#70880) 2021-03-25 14:07:27 -04:00
tab-widgets [DOCS] Replace put with create or update in API names (#70330) (#70421) 2021-03-15 17:16:13 -04:00
text-structure/apis [ML] [DOCS] update find-structure reference docs (#67586) (#67592) 2021-01-15 13:22:59 -05:00
transform [DOCS] Reorganizes Transforms limitations (#70638) (#70806) 2021-03-24 11:58:53 +01:00
upgrade [DOCS] Make cat API verbose query param explicit (#67300) (#67305) 2021-01-12 08:33:50 -05:00
vectors [DOCS] Update my-index examples (#60132) (#60248) 2020-07-27 15:58:26 -04:00
aggregations.asciidoc [DOCS] Rewrite aggs overview (#64318) (#64409) 2020-10-30 09:29:26 -04:00
analysis.asciidoc [DOCS] Fix Lucene's stop words links (#70405) (#70475) 2021-03-16 17:44:42 -04:00
api-conventions.asciidoc [DOCS] Document date math support for aliases (#70535) (#70567) 2021-03-18 11:04:18 -04:00
cat.asciidoc [7.x] Fix docs/reference/cat.asciidoc to use consistent order (#69938) (#69941) 2021-03-03 16:55:36 -07:00
cluster.asciidoc [DOCS] Reword node roles docs (#69301) (#69459) 2021-02-23 12:02:53 -05:00
data-management.asciidoc [DOCS] Move Kibana index mgmt docs to ES (#64380) (#64413) 2020-10-30 09:29:59 -04:00
data-rollup-transform.asciidoc [DOCS] Add overview for rollup refactor (#70001) (#70233) 2021-03-10 09:03:56 -05:00
datatiers.asciidoc Additional docs for shared_cache searchable snapshots (#70566) (#70660) 2021-03-22 17:32:31 +01:00
dependencies-versions.asciidoc [DOCS] Added appendix to show dependencies (#67962) (#68033) 2021-01-26 16:53:43 -08:00
docs.asciidoc [DOCS] Remove heading offsets for REST APIs (#44568) 2019-07-19 14:36:06 -04:00
frozen-indices.asciidoc [DOCS] Make cat API verbose query param explicit (#67300) (#67305) 2021-01-12 08:33:50 -05:00
getting-started.asciidoc [DOCS] Make cat API verbose query param explicit (#67300) (#67305) 2021-01-12 08:33:50 -05:00
glossary.asciidoc [DOCS] Replace external links with xrefs (#70667) (#70671) 2021-03-22 13:08:44 -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) (#57743) 2020-06-05 12:08:45 -04:00
how-to.asciidoc [DOCS] Fix 'How To' title (#70772) (#70774) 2021-03-23 14:23:33 -04:00
index-modules.asciidoc [DOCS] Document index.query.default_field index setting (#69922) (#70528) 2021-03-17 17:35:08 -04:00
index.asciidoc [DOCS] Added appendix to show dependencies (#67962) (#68033) 2021-01-26 16:53:43 -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) (#70421) 2021-03-15 17:16:13 -04:00
ingest.asciidoc [DOCS] Document on_failure param for create pipeline API (#70679) (#70736) 2021-03-23 09:35:06 -04:00
intro.asciidoc [DOCS] Update rollup xrefs (#66799) (#66800) 2020-12-23 14:25:16 -05:00
links.asciidoc [DOCS] Fix security links in machine learning APIs (#60098) (#60152) 2020-07-23 16:43:10 -07:00
mapping.asciidoc [DOCS] [7.x] Runtime fields improvements (#66530) (#67271) 2021-01-11 12:55:05 -05:00
query-dsl.asciidoc [DOCS] Combine keyword family docs (#61662) (#61813) 2020-09-01 15:32:56 -04:00
redirects.asciidoc [DOCS] [7.x] Overhaul TLS security docs (#68946) (#70880) 2021-03-25 14:07:27 -04:00
release-notes.asciidoc Add release notes for 7.12.0 (#69303) 2021-03-22 12:16:28 -04:00
scripting.asciidoc [DOCS] [7.x] Focus scripting docs on Painless (#69748) (#70588) 2021-03-18 17:33:44 -04:00
search.asciidoc Introduce eql search status API (#68065) (#68913) 2021-02-11 11:05:21 -05:00
setup.asciidoc Introduce ES_JAVA_HOME (#68954) 2021-02-17 12:44:34 -05:00
upgrade.asciidoc [DOCS] Update upgrade docs for 7.13 (#69213) 2021-02-18 14:43:56 -05:00