Skip to content

Commit 1d76221

Browse files
committed
[DOCS] Add anchors for Asciidoctor migration (#41648)
1 parent 24184d5 commit 1d76221

36 files changed

+67
-3
lines changed

docs/reference/aggregations/bucket/diversified-sampler-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ Please note that Elasticsearch will ignore the choice of execution hint if it is
144144

145145
==== Limitations
146146

147+
[[div-sampler-breadth-first-nested-agg]]
147148
===== Cannot be nested under `breadth_first` aggregations
148149
Being a quality-based filter the sampler aggregation needs access to the relevance score produced for each document.
149150
It therefore cannot be nested under a `terms` aggregation which has the `collect_mode` switched from the default `depth_first` mode to `breadth_first` as this discards scores.
@@ -152,6 +153,7 @@ In this situation an error will be thrown.
152153
===== Limited de-dup logic.
153154
The de-duplication logic in the diversify settings applies only at a shard level so will not apply across shards.
154155

156+
[[spec-syntax-geo-date-fields]]
155157
===== No specialized syntax for geo/date fields
156158
Currently the syntax for defining the diversifying values is defined by a choice of `field` or
157159
`script` - there is no added syntactical sugar for expressing geo or date units such as "7d" (7

docs/reference/aggregations/bucket/filters-aggregation.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ request. The response for this example would be:
118118
// TESTRESPONSE[s/"_shards": \.\.\./"_shards": $body._shards/]
119119
// TESTRESPONSE[s/"hits": \.\.\./"hits": $body.hits/]
120120

121+
[[other-bucket]]
121122
==== `Other` Bucket
122123

123124
The `other_bucket` parameter can be set to add a bucket to the response which will contain all documents that do

docs/reference/aggregations/bucket/sampler-aggregation.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ The default value is 100.
7070

7171
==== Limitations
7272

73+
[[sampler-breadth-first-nested-agg]]
7374
===== Cannot be nested under `breadth_first` aggregations
7475
Being a quality-based filter the sampler aggregation needs access to the relevance score produced for each document.
7576
It therefore cannot be nested under a `terms` aggregation which has the `collect_mode` switched from the default `depth_first` mode to `breadth_first` as this discards scores.

docs/reference/aggregations/bucket/significantterms-aggregation.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,7 @@ Available parameters in the script are
370370
`_subset_size`:: Number of documents in the subset.
371371
`_superset_size`:: Number of documents in the superset.
372372

373+
[[sig-terms-shard-size]]
373374
===== Size & Shard Size
374375

375376
The `size` parameter can be set to define how many term buckets should be returned out of the overall terms list. By

docs/reference/aggregations/pipeline/avg-bucket-aggregation.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ experimental[]
66
A sibling pipeline aggregation which calculates the (mean) average value of a specified metric in a sibling aggregation.
77
The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.
88

9+
[[avg-bucket-agg-syntax]]
910
==== Syntax
1011

1112
An `avg_bucket` aggregation looks like this in isolation:
@@ -19,7 +20,9 @@ An `avg_bucket` aggregation looks like this in isolation:
1920
}
2021
--------------------------------------------------
2122

23+
[[avg-bucket-params]]
2224
.`avg_bucket` Parameters
25+
[options="header"]
2326
|===
2427
|Parameter Name |Description |Required |Default Value
2528
|`buckets_path` |The path to the buckets we wish to find the average for (see <<buckets-path-syntax>> for more

docs/reference/aggregations/pipeline/bucket-script-aggregation.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ experimental[]
66
A parent pipeline aggregation which executes a script which can perform per bucket computations on specified metrics
77
in the parent multi-bucket aggregation. The specified metric must be numeric and the script must return a numeric value.
88

9+
[[bucket-script-agg-syntax]]
910
==== Syntax
1011

1112
A `bucket_script` aggregation looks like this in isolation:
@@ -25,8 +26,9 @@ A `bucket_script` aggregation looks like this in isolation:
2526
<1> Here, `my_var1` is the name of the variable for this buckets path to use in the script, `the_sum` is the path to
2627
the metrics to use for that variable.
2728

28-
29+
[[bucket-script-params]]
2930
.`bucket_script` Parameters
31+
[options="header"]
3032
|===
3133
|Parameter Name |Description |Required |Default Value
3234
|`script` |The script to run for this aggregation. The script can be inline, file or indexed. (see <<modules-scripting>>

docs/reference/aggregations/pipeline/bucket-selector-aggregation.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ A `bucket_selector` aggregation looks like this in isolation:
3030
<1> Here, `my_var1` is the name of the variable for this buckets path to use in the script, `the_sum` is the path to
3131
the metrics to use for that variable.
3232

33-
33+
[[bucket-selector-params]]
3434
.`bucket_selector` Parameters
35+
[options="header"]
3536
|===
3637
|Parameter Name |Description |Required |Default Value
3738
|`script` |The script to run for this aggregation. The script can be inline, file or indexed. (see <<modules-scripting>>

docs/reference/aggregations/pipeline/cumulative-sum-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ A `cumulative_sum` aggregation looks like this in isolation:
2020
}
2121
--------------------------------------------------
2222

23+
[[cumulative-sum-params]]
2324
.`cumulative_sum` Parameters
25+
[options="header"]
2426
|===
2527
|Parameter Name |Description |Required |Default Value
2628
|`buckets_path` |The path to the buckets we wish to find the cumulative sum for (see <<buckets-path-syntax>> for more

docs/reference/aggregations/pipeline/derivative-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ A `derivative` aggregation looks like this in isolation:
1818
}
1919
--------------------------------------------------
2020

21+
[[derivative-params]]
2122
.`derivative` Parameters
23+
[options="header"]
2224
|===
2325
|Parameter Name |Description |Required |Default Value
2426
|`buckets_path` |The path to the buckets we wish to find the derivative for (see <<buckets-path-syntax>> for more

docs/reference/aggregations/pipeline/extended-stats-bucket-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ A `extended_stats_bucket` aggregation looks like this in isolation:
2121
}
2222
--------------------------------------------------
2323

24+
[[extended-stats-bucket-params]]
2425
.`extended_stats_bucket` Parameters
26+
[options="header"]
2527
|===
2628
|Parameter Name |Description |Required |Default Value
2729
|`buckets_path` |The path to the buckets we wish to calculate stats for (see <<buckets-path-syntax>> for more

docs/reference/aggregations/pipeline/max-bucket-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ A `max_bucket` aggregation looks like this in isolation:
2020
}
2121
--------------------------------------------------
2222

23+
[[max-bucket-params]]
2324
.`max_bucket` Parameters
25+
[options="header"]
2426
|===
2527
|Parameter Name |Description |Required |Default Value
2628
|`buckets_path` |The path to the buckets we wish to find the maximum for (see <<buckets-path-syntax>> for more

docs/reference/aggregations/pipeline/min-bucket-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ A `max_bucket` aggregation looks like this in isolation:
2020
}
2121
--------------------------------------------------
2222

23+
[[min-bucket-params]]
2324
.`min_bucket` Parameters
25+
[options="header"]
2426
|===
2527
|Parameter Name |Description |Required |Default Value
2628
|`buckets_path` |The path to the buckets we wish to find the minimum for (see <<buckets-path-syntax>> for more

docs/reference/aggregations/pipeline/percentiles-bucket-aggregation.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ A `percentiles_bucket` aggregation looks like this in isolation:
1919
}
2020
--------------------------------------------------
2121

22+
23+
[[sum-bucket-params]]
2224
.`sum_bucket` Parameters
25+
[options="header"]
2326
|===
2427
|Parameter Name |Description |Required |Default Value
2528
|`buckets_path` |The path to the buckets we wish to find the sum for (see <<buckets-path-syntax>> for more

docs/reference/aggregations/pipeline/serial-diff-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ A `serial_diff` aggregation looks like this in isolation:
4747
}
4848
--------------------------------------------------
4949

50+
[[serial-diff-params]]
5051
.`serial_diff` Parameters
52+
[options="header"]
5153
|===
5254
|Parameter Name |Description |Required |Default Value
5355
|`buckets_path` |Path to the metric of interest (see <<buckets-path-syntax, `buckets_path` Syntax>> for more details |Required |

docs/reference/aggregations/pipeline/stats-bucket-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ A `stats_bucket` aggregation looks like this in isolation:
1919
}
2020
--------------------------------------------------
2121

22+
[[stats-bucket-params]]
2223
.`stats_bucket` Parameters
24+
[options="header"]
2325
|===
2426
|Parameter Name |Description |Required |Default Value
2527
|`buckets_path` |The path to the buckets we wish to calculate stats for (see <<buckets-path-syntax>> for more

docs/reference/aggregations/pipeline/sum-bucket-aggregation.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ A `sum_bucket` aggregation looks like this in isolation:
1919
}
2020
--------------------------------------------------
2121

22+
[[sum-bucket-params]]
2223
.`sum_bucket` Parameters
24+
[options="header"]
2325
|===
2426
|Parameter Name |Description |Required |Default Value
2527
|`buckets_path` |The path to the buckets we wish to find the sum for (see <<buckets-path-syntax>> for more

docs/reference/docs/refresh.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ general, if you have a running system you don't wish to disturb then
6363
`refresh=wait_for` is a smaller modification.
6464

6565
[float]
66+
[[refresh_wait_for-force-refresh]]
6667
=== `refresh=wait_for` Can Force a Refresh
6768

6869
If a `refresh=wait_for` request comes in when there are already

docs/reference/docs/update.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,7 @@ POST test/type1/1/_update
218218
// TEST[continued]
219219

220220
[float]
221+
[[scripted_upsert]]
221222
==== `scripted_upsert`
222223

223224
If you would like your script to run regardless of whether the document exists
@@ -244,6 +245,7 @@ POST sessions/session/dh3sgudg8gsrgl/_update
244245
--------------------------------------------------
245246

246247
[float]
248+
[[doc_as_upsert]]
247249
==== `doc_as_upsert`
248250

249251
Instead of sending a partial `doc` plus an `upsert` doc, setting

docs/reference/getting-started.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,7 @@ This REST access pattern is pervasive throughout all the API commands that if yo
407407
Elasticsearch provides data manipulation and search capabilities in near real time. By default, you can expect a one second delay (refresh interval) from the time you index/update/delete your data until the time that it appears in your search results. This is an important distinction from other platforms like SQL wherein data is immediately available after a transaction is completed.
408408

409409
[float]
410+
[[indexing-replacing-documents]]
410411
=== Indexing/Replacing Documents
411412

412413
We've previously seen how we can index a single document. Let's recall that command again:

docs/reference/how-to/disk-usage.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ PUT index
9999
// CONSOLE
100100

101101
[float]
102+
[[default-dynamic-string-mapping]]
102103
=== Don't use default dynamic string mappings
103104

104105
The default <<dynamic-mapping,dynamic string mappings>> will index string fields
@@ -136,6 +137,7 @@ PUT index
136137
// CONSOLE
137138

138139
[float]
140+
[[disable-all]]
139141
=== Disable `_all`
140142

141143
The <<mapping-all-field,`_all`>> field indexes the value of all fields of a

docs/reference/how-to/indexing-speed.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ it is advisable to avoid going beyond a couple tens of megabytes per request
1717
even if larger requests seem to perform better.
1818

1919
[float]
20+
[[multiple-workers-threads]]
2021
=== Use multiple workers/threads to send data to Elasticsearch
2122

2223
A single thread sending bulk requests is unlikely to be able to max out the

docs/reference/mapping/dynamic/templates.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@ PUT my_index
283283
}
284284
--------------------------------------------------
285285

286+
[[text-only-mappings-strings]]
286287
===== `text`-only mappings for strings
287288

288289
On the contrary to the previous example, if the only thing that you care about

docs/reference/mapping/fields/source-field.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ at index time. The `_source` field itself is not indexed (and thus is not
66
searchable), but it is stored so that it can be returned when executing
77
_fetch_ requests, like <<docs-get,get>> or <<search-search,search>>.
88

9+
[[disable-source-field]]
910
==== Disabling the `_source` field
1011

1112
Though very handy to have around, the source field does incur storage overhead

docs/reference/mapping/params/fielddata.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ reading the entire inverted index for each segment from disk, inverting the
1919
term ↔︎ document relationship, and storing the result in memory, in the JVM
2020
heap.
2121

22+
[[fielddata-disabled-text-fields]]
2223
==== Fielddata is disabled on `text` fields by default
2324

2425
Fielddata can consume a *lot* of heap space, especially when loading high
@@ -77,6 +78,7 @@ PUT my_index
7778
<1> Use the `my_field` field for searches.
7879
<2> Use the `my_field.keyword` field for aggregations, sorting, or in scripts.
7980

81+
[[enable-fielddata-text-fields]]
8082
==== Enabling fielddata on `text` fields
8183

8284
You can enable fielddata on an existing `text` field using the

docs/reference/mapping/types/geo-shape.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ API.
249249
--------------------------------------------------
250250

251251
[float]
252+
[[linestring]]
252253
===== http://geojson.org/geojson-spec.html#id3[LineString]
253254

254255
A `linestring` defined by an array of two or more positions. By
@@ -269,6 +270,7 @@ The above `linestring` would draw a straight line starting at the White
269270
House to the US Capitol Building.
270271

271272
[float]
273+
[[polygon]]
272274
===== http://www.geojson.org/geojson-spec.html#id4[Polygon]
273275

274276
A polygon is defined by a list of a list of points. The first and last
@@ -352,6 +354,7 @@ overriding the orientation on a document:
352354
--------------------------------------------------
353355

354356
[float]
357+
[[multipoint]]
355358
===== http://www.geojson.org/geojson-spec.html#id5[MultiPoint]
356359

357360
A list of geojson points.
@@ -369,6 +372,7 @@ A list of geojson points.
369372
--------------------------------------------------
370373

371374
[float]
375+
[[multilinestring]]
372376
===== http://www.geojson.org/geojson-spec.html#id6[MultiLineString]
373377

374378
A list of geojson linestrings.
@@ -388,6 +392,7 @@ A list of geojson linestrings.
388392
--------------------------------------------------
389393

390394
[float]
395+
[[multipolygon]]
391396
===== http://www.geojson.org/geojson-spec.html#id7[MultiPolygon]
392397

393398
A list of geojson polygons.
@@ -408,6 +413,7 @@ A list of geojson polygons.
408413
--------------------------------------------------
409414

410415
[float]
416+
[[geometry_collection]]
411417
===== http://geojson.org/geojson-spec.html#geometrycollection[Geometry Collection]
412418

413419
A collection of geojson geometry objects.

docs/reference/mapping/types/ip.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ The following parameters are accepted by `ip` fields:
7777
the <<mapping-source-field,`_source`>> field. Accepts `true` or `false`
7878
(default).
7979

80+
[[query-ip-fields]]
8081
==== Querying `ip` fields
8182

8283
The most common way to query ip addresses is to use the

docs/reference/mapping/types/nested.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ GET my_index/_search
6464
// CONSOLE
6565
// TEST[continued]
6666

67+
[[nested-fields-array-objects]]
6768
==== Using `nested` fields for arrays of objects
6869

6970
If you need to index arrays of objects and to maintain the independence of

docs/reference/mapping/types/percolator.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ fail.
7474
==== Limitations
7575

7676
[float]
77+
[[parent-child]]
7778
===== Parent/child
7879

7980
Because the `percolate` query is processing one document at a time, it doesn't support queries and filters that run

docs/reference/modules/scripting/expression.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ The following example shows the difference in years between the `date` fields da
112112
`doc['date1'].date.year - doc['date0'].date.year`
113113

114114
[float]
115+
[[geo-point-field-api]]
115116
=== `geo_point` field API
116117
[cols="<,<",options="header",]
117118
|=======================================================================

docs/reference/modules/snapshots.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,7 @@ GET /_snapshot/my_backup/snapshot_1,snapshot_2/_status
460460
// CONSOLE
461461

462462
[float]
463+
[[monitor-snapshot-restore-progress]]
463464
=== Monitoring snapshot/restore progress
464465

465466
There are several ways to monitor the progress of the snapshot and restores processes while they are running. Both

docs/reference/modules/threadpool.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ thread_pool:
6868
The following are the types of thread pools and their respective parameters:
6969

7070
[float]
71+
[[fixed]]
7172
==== `fixed`
7273

7374
The `fixed` thread pool holds a fixed size of threads to handle the
@@ -91,6 +92,7 @@ thread_pool:
9192
--------------------------------------------------
9293

9394
[float]
95+
[[scaling]]
9496
==== `scaling`
9597

9698
The `scaling` thread pool holds a dynamic number of threads. This

docs/reference/query-dsl/bool-query.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ POST _search
7575
--------------------------------------------------
7676
// CONSOLE
7777

78+
[[score-bool-filter]]
7879
==== Scoring with `bool.filter`
7980

8081
Queries specified under the `filter` element have no effect on scoring --

docs/reference/query-dsl/exists-query.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ These documents would *not* match the above query:
4242
<3> The `user` field is missing completely.
4343

4444
[float]
45+
[[null-value-mapping]]
4546
==== `null_value` mapping
4647

4748
If the field mapping includes the <<null-value,`null_value`>> setting
@@ -74,6 +75,7 @@ no values in the `user` field and thus would not match the `exists` filter:
7475
{ "foo": "bar" }
7576
--------------------------------------------------
7677

78+
[[missing-query]]
7779
==== `missing` query
7880

7981
'missing' query has been removed because it can be advantageously replaced by an `exists` query inside a must_not

0 commit comments

Comments
 (0)