Skip to content

Commit adf6705

Browse files
authored
[DOCS] Add anchors for Asciidoctor migration (#41648)
1 parent 217f5b9 commit adf6705

File tree

66 files changed

+146
-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.

66 files changed

+146
-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 |

0 commit comments

Comments
 (0)