Skip to content

Commit 2ce2ff6

Browse files
committed
[DOCS] Add anchors for Asciidoctor migration (#41648)
1 parent 6c58a8b commit 2ce2ff6

File tree

64 files changed

+142
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+142
-11
lines changed

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

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

187187
==== Limitations
188188

189+
[[div-sampler-breadth-first-nested-agg]]
189190
===== Cannot be nested under `breadth_first` aggregations
190191
Being a quality-based filter the diversified_sampler aggregation needs access to the relevance score produced for each document.
191192
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.
@@ -194,6 +195,7 @@ In this situation an error will be thrown.
194195
===== Limited de-dup logic.
195196
The de-duplication logic applies only at a shard level so will not apply across shards.
196197

198+
[[spec-syntax-geo-date-fields]]
197199
===== No specialized syntax for geo/date fields
198200
Currently the syntax for defining the diversifying values is defined by a choice of `field` or
199201
`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
@@ -155,6 +155,7 @@ The default value is 100.
155155

156156
==== Limitations
157157

158+
[[sampler-breadth-first-nested-agg]]
158159
===== Cannot be nested under `breadth_first` aggregations
159160
Being a quality-based filter the sampler aggregation needs access to the relevance score produced for each document.
160161
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
@@ -436,6 +436,7 @@ Available parameters in the script are
436436
`_subset_size`:: Number of documents in the subset.
437437
`_superset_size`:: Number of documents in the superset.
438438

439+
[[sig-terms-shard-size]]
439440
===== Size & Shard Size
440441

441442
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/bucket/significanttext-aggregation.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ It only occurs 5 times in our index as a whole (see the `bg_count`) and yet 4 of
9292
were lucky enough to appear in our 100 document sample of "bird flu" results. That suggests
9393
a significant word and one which the user can potentially add to their search.
9494

95-
95+
[[filter-duplicate-text-noisy-data]]
9696
==== Dealing with noisy data using `filter_duplicate_text`
9797
Free-text fields often contain a mix of original content and mechanical copies of text (cut-and-paste biographies, email reply chains,
9898
retweets, boilerplate headers/footers, page navigation menus, sidebar news links, copyright notices, standard disclaimers, addresses).
@@ -353,7 +353,7 @@ However, the `size` and `shard size` settings covered in the next section provid
353353

354354
This aggregation supports the same scoring heuristics (JLH, mutual_information, gnd, chi_square etc) as the <<search-aggregations-bucket-significantterms-aggregation,significant terms>> aggregation
355355

356-
356+
[[sig-text-shard-size]]
357357
===== Size & Shard Size
358358

359359
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/metrics/weighted-avg-aggregation.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ As a formula, a weighted average is the `∑(value * weight) / ∑(weight)`
1212

1313
A regular average can be thought of as a weighted average where every value has an implicit weight of `1`.
1414

15+
[[weighted-avg-params]]
1516
.`weighted_avg` Parameters
17+
[options="header"]
1618
|===
1719
|Parameter Name |Description |Required |Default Value
1820
|`value` | The configuration for the field or script that provides the values |Required |
@@ -23,15 +25,19 @@ A regular average can be thought of as a weighted average where every value has
2325

2426
The `value` and `weight` objects have per-field specific configuration:
2527

28+
[[value-params]]
2629
.`value` Parameters
30+
[options="header"]
2731
|===
2832
|Parameter Name |Description |Required |Default Value
2933
|`field` | The field that values should be extracted from |Required |
3034
|`missing` | A value to use if the field is missing entirely |Optional |
3135
|`script` | A script which provides the values for the document. This is mutually exclusive with `field` |Optional
3236
|===
3337

38+
[[weight-params]]
3439
.`weight` Parameters
40+
[options="header"]
3541
|===
3642
|Parameter Name |Description |Required |Default Value
3743
|`field` | The field that weights should be extracted from |Required |

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

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

7+
[[avg-bucket-agg-syntax]]
78
==== Syntax
89

910
An `avg_bucket` aggregation looks like this in isolation:
@@ -18,7 +19,9 @@ An `avg_bucket` aggregation looks like this in isolation:
1819
--------------------------------------------------
1920
// NOTCONSOLE
2021

22+
[[avg-bucket-params]]
2123
.`avg_bucket` Parameters
24+
[options="header"]
2225
|===
2326
|Parameter Name |Description |Required |Default Value
2427
|`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
@@ -4,6 +4,7 @@
44
A parent pipeline aggregation which executes a script which can perform per bucket computations on specified metrics
55
in the parent multi-bucket aggregation. The specified metric must be numeric and the script must return a numeric value.
66

7+
[[bucket-script-agg-syntax]]
78
==== Syntax
89

910
A `bucket_script` aggregation looks like this in isolation:
@@ -24,8 +25,9 @@ A `bucket_script` aggregation looks like this in isolation:
2425
<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
2526
the metrics to use for that variable.
2627

27-
28+
[[bucket-script-params]]
2829
.`bucket_script` Parameters
30+
[options="header"]
2931
|===
3032
|Parameter Name |Description |Required |Default Value
3133
|`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
@@ -29,8 +29,9 @@ A `bucket_selector` aggregation looks like this in isolation:
2929
<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
3030
the metrics to use for that variable.
3131

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ A `bucket_sort` aggregation looks like this in isolation:
3333
<1> Here, `sort_field_1` is the bucket path to the variable to be used as the primary sort and its order
3434
is ascending.
3535

36+
[[bucket-sort-params]]
3637
.`bucket_sort` Parameters
38+
[options="header"]
3739
|===
3840
|Parameter Name |Description |Required |Default Value
3941
|`sort` |The list of fields to sort on. See <<search-request-sort,`sort`>> for more details. |Optional |

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

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

22+
[[cumulative-sum-params]]
2223
.`cumulative_sum` 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 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
@@ -17,7 +17,9 @@ A `derivative` aggregation looks like this in isolation:
1717
--------------------------------------------------
1818
// NOTCONSOLE
1919

20+
[[derivative-params]]
2021
.`derivative` Parameters
22+
[options="header"]
2123
|===
2224
|Parameter Name |Description |Required |Default Value
2325
|`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
@@ -20,7 +20,9 @@ A `extended_stats_bucket` aggregation looks like this in isolation:
2020
--------------------------------------------------
2121
// NOTCONSOLE
2222

23+
[[extended-stats-bucket-params]]
2324
.`extended_stats_bucket` Parameters
25+
[options="header"]
2426
|===
2527
|Parameter Name |Description |Required |Default Value
2628
|`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
@@ -19,7 +19,9 @@ A `max_bucket` aggregation looks like this in isolation:
1919
--------------------------------------------------
2020
// NOTCONSOLE
2121

22+
[[max-bucket-params]]
2223
.`max_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 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
@@ -19,7 +19,9 @@ A `min_bucket` aggregation looks like this in isolation:
1919
--------------------------------------------------
2020
// NOTCONSOLE
2121

22+
[[min-bucket-params]]
2223
.`min_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 minimum for (see <<buckets-path-syntax>> for more

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ A `moving_fn` aggregation looks like this in isolation:
2424
--------------------------------------------------
2525
// NOTCONSOLE
2626

27+
[[moving-avg-params]]
2728
.`moving_avg` Parameters
29+
[options="header"]
2830
|===
2931
|Parameter Name |Description |Required |Default Value
3032
|`buckets_path` |Path to the metric of interest (see <<buckets-path-syntax, `buckets_path` Syntax>> for more details |Required |
@@ -188,7 +190,9 @@ The functions are available from the `MovingFunctions` namespace. E.g. `MovingF
188190
This function accepts a collection of doubles and returns the maximum value in that window. `null` and `NaN` values are ignored; the maximum
189191
is only calculated over the real values. If the window is empty, or all values are `null`/`NaN`, `NaN` is returned as the result.
190192

193+
[[max-params]]
191194
.`max(double[] values)` Parameters
195+
[options="header"]
192196
|===
193197
|Parameter Name |Description
194198
|`values` |The window of values to find the maximum
@@ -229,7 +233,9 @@ POST /_search
229233
This function accepts a collection of doubles and returns the minimum value in that window. `null` and `NaN` values are ignored; the minimum
230234
is only calculated over the real values. If the window is empty, or all values are `null`/`NaN`, `NaN` is returned as the result.
231235

236+
[[min-params]]
232237
.`min(double[] values)` Parameters
238+
[options="header"]
233239
|===
234240
|Parameter Name |Description
235241
|`values` |The window of values to find the minimum
@@ -270,7 +276,9 @@ POST /_search
270276
This function accepts a collection of doubles and returns the sum of the values in that window. `null` and `NaN` values are ignored;
271277
the sum is only calculated over the real values. If the window is empty, or all values are `null`/`NaN`, `0.0` is returned as the result.
272278

279+
[[sum-params]]
273280
.`sum(double[] values)` Parameters
281+
[options="header"]
274282
|===
275283
|Parameter Name |Description
276284
|`values` |The window of values to find the sum of
@@ -312,7 +320,9 @@ This function accepts a collection of doubles and average, then returns the stan
312320
`null` and `NaN` values are ignored; the sum is only calculated over the real values. If the window is empty, or all values are
313321
`null`/`NaN`, `0.0` is returned as the result.
314322

323+
[[stddev-params]]
315324
.`stdDev(double[] values)` Parameters
325+
[options="header"]
316326
|===
317327
|Parameter Name |Description
318328
|`values` |The window of values to find the standard deviation of
@@ -363,7 +373,9 @@ the values from a `simple` moving average tend to "lag" behind the real data.
363373
`null`/`NaN`, `NaN` is returned as the result. This means that the count used in the average calculation is count of non-`null`,non-`NaN`
364374
values.
365375

376+
[[unweightedavg-params]]
366377
.`unweightedAvg(double[] values)` Parameters
378+
[options="header"]
367379
|===
368380
|Parameter Name |Description
369381
|`values` |The window of values to find the sum of
@@ -407,7 +419,9 @@ the "lag" behind the data's mean, since older points have less influence.
407419

408420
If the window is empty, or all values are `null`/`NaN`, `NaN` is returned as the result.
409421

422+
[[linearweightedavg-params]]
410423
.`linearWeightedAvg(double[] values)` Parameters
424+
[options="header"]
411425
|===
412426
|Parameter Name |Description
413427
|`values` |The window of values to find the sum of
@@ -456,7 +470,9 @@ moving average. This tends to make the moving average track the data more close
456470
`null`/`NaN`, `NaN` is returned as the result. This means that the count used in the average calculation is count of non-`null`,non-`NaN`
457471
values.
458472

473+
[[ewma-params]]
459474
.`ewma(double[] values, double alpha)` Parameters
475+
[options="header"]
460476
|===
461477
|Parameter Name |Description
462478
|`values` |The window of values to find the sum of
@@ -511,7 +527,9 @@ Values are produced by multiplying the level and trend components.
511527
`null`/`NaN`, `NaN` is returned as the result. This means that the count used in the average calculation is count of non-`null`,non-`NaN`
512528
values.
513529

530+
[[holt-params]]
514531
.`holt(double[] values, double alpha)` Parameters
532+
[options="header"]
515533
|===
516534
|Parameter Name |Description
517535
|`values` |The window of values to find the sum of
@@ -572,7 +590,9 @@ for future enhancements.
572590
`null`/`NaN`, `NaN` is returned as the result. This means that the count used in the average calculation is count of non-`null`,non-`NaN`
573591
values.
574592

593+
[[holtwinters-params]]
575594
.`holtWinters(double[] values, double alpha)` Parameters
595+
[options="header"]
576596
|===
577597
|Parameter Name |Description
578598
|`values` |The window of values to find the sum of

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

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

21+
[[percentiles-bucket-params]]
2122
.`percentiles_bucket` 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 percentiles 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
@@ -46,7 +46,9 @@ A `serial_diff` aggregation looks like this in isolation:
4646
--------------------------------------------------
4747
// NOTCONSOLE
4848

49+
[[serial-diff-params]]
4950
.`serial_diff` Parameters
51+
[options="header"]
5052
|===
5153
|Parameter Name |Description |Required |Default Value
5254
|`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
@@ -18,7 +18,9 @@ A `stats_bucket` aggregation looks like this in isolation:
1818
--------------------------------------------------
1919
// NOTCONSOLE
2020

21+
[[stats-bucket-params]]
2122
.`stats_bucket` Parameters
23+
[options="header"]
2224
|===
2325
|Parameter Name |Description |Required |Default Value
2426
|`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
@@ -18,7 +18,9 @@ A `sum_bucket` aggregation looks like this in isolation:
1818
--------------------------------------------------
1919
// NOTCONSOLE
2020

21+
[[sum-bucket-params]]
2122
.`sum_bucket` 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 sum for (see <<buckets-path-syntax>> for more

docs/reference/analysis/tokenfilters/synonym-graph-tokenfilter.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ set to `false` no mapping would get added as when `expand=false` the target mapp
9393
stop word.
9494

9595
[float]
96+
[[synonym-graph-tokenizer-ignore_case-deprecated]]
9697
==== `tokenizer` and `ignore_case` are deprecated
9798

9899
The `tokenizer` parameter controls the tokenizers that will be used to

docs/reference/analysis/tokenfilters/synonym-tokenfilter.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ stop word.
8383

8484

8585
[float]
86+
[[synonym-tokenizer-ignore_case-deprecated]]
8687
==== `tokenizer` and `ignore_case` are deprecated
8788

8889
The `tokenizer` parameter controls the tokenizers that will be used to

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
@@ -243,6 +243,7 @@ POST test/_update/1
243243
// TEST[continued]
244244

245245
[float]
246+
[[scripted_upsert]]
246247
==== `scripted_upsert`
247248

248249
If you would like your script to run regardless of whether the document exists
@@ -272,6 +273,7 @@ POST sessions/_update/dh3sgudg8gsrgl
272273
// TEST[continued]
273274

274275
[float]
276+
[[doc_as_upsert]]
275277
==== `doc_as_upsert`
276278

277279
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
@@ -505,6 +505,7 @@ This REST access pattern is so pervasive throughout all the API commands that if
505505
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.
506506

507507
[float]
508+
[[indexing-replacing-documents]]
508509
=== Indexing/Replacing Documents
509510

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

0 commit comments

Comments
 (0)