Skip to content

Commit 08552f1

Browse files
[docs] Fix various syntax and rendering errors (#127062)
* fix syntax and rendering errors * clean up * fix versions * more clean up * more fixes * more fixes * more fixes
1 parent 41eefb6 commit 08552f1

File tree

95 files changed

+1443
-1199
lines changed

Some content is hidden

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

95 files changed

+1443
-1199
lines changed

docs/docset.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ toc:
2828
- toc: release-notes
2929
- toc: extend
3030
subs:
31+
version: 9.0.0
3132
api-request-title: "Request"
3233
api-prereq-title: "Prerequisites"
3334
api-description-title: "Description"
@@ -96,8 +97,8 @@ subs:
9697
transforms-cap: "Transforms"
9798
dfanalytics-cap: "Data frame analytics"
9899
dfanalytics: "data frame analytics"
99-
dfanalytics-job: "'{dataframe} analytics job'"
100-
dfanalytics-jobs: "'{dataframe} analytics jobs'"
100+
dfanalytics-job: "data frame analytics job"
101+
dfanalytics-jobs: "data frame analytics jobs"
101102
ctransforms: "continuous transforms"
102103
regression: "regression"
103104
regression-cap: "Regression"

docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,12 @@ The response contains buckets with document counts for each filter and combinati
9494
`filters`
9595
: (Required, object) Filters used to create buckets.
9696

97-
::::{dropdown} Properties of `filters`
98-
`<filter>`
99-
: (Required, [Query DSL object](/reference/query-languages/querydsl.md)) Query used to filter documents. The key is the filter name.
97+
::::{dropdown} Properties of filters
98+
`<filter>`
99+
: (Required, [Query DSL object](/reference/query-languages/querydsl.md)) Query used to filter documents. The key is the filter name.
100100

101-
At least one filter is required. The total number of filters cannot exceed the [`indices.query.bool.max_clause_count`](/reference/elasticsearch/configuration-reference/search-settings.md#indices-query-bool-max-clause-count) setting. See [Filter limits](#adjacency-matrix-agg-filter-limits).
102-
103-
104-
::::
101+
At least one filter is required. The total number of filters cannot exceed the [`indices.query.bool.max_clause_count`](/reference/elasticsearch/configuration-reference/search-settings.md#indices-query-bool-max-clause-count) setting. See [Filter limits](#adjacency-matrix-agg-filter-limits).
102+
::::
105103

106104

107105
`separator`

docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ The algorithm used for categorization was completely changed in version 8.3.0. A
2626

2727
The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string it must refer to a [built-in analyzer](/reference/text-analysis/analyzer-reference.md) or one added by another plugin. If it is an object it has the following properties:
2828

29-
:::::{dropdown} Properties of `categorization_analyzer`
29+
**Properties of `categorization_analyzer`**:
30+
3031
`char_filter`
3132
: (array of strings or objects) One or more [character filters](/reference/text-analysis/character-filter-reference.md). In addition to the built-in character filters, other plugins can provide more character filters. This property is optional. If it is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as [pattern replace character filters](/reference/text-analysis/analysis-pattern-replace-charfilter.md).
3233

@@ -41,8 +42,6 @@ The algorithm used for categorization was completely changed in version 8.3.0. A
4142
`filter`
4243
: (array of strings or objects) One or more [token filters](/reference/text-analysis/token-filter-reference.md). In addition to the built-in token filters, other plugins can provide more token filters. This property is optional. If it is not specified, no token filters are applied prior to categorization.
4344

44-
:::::
45-
4645

4746
`categorization_filters`
4847
: (Optional, array of strings) This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as `pattern_replace` character filters.

docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation.md

+17-27
Original file line numberDiff line numberDiff line change
@@ -11,43 +11,33 @@ A sibling pipeline aggregation which executes a correlation function on the conf
1111

1212
## Parameters [bucket-correlation-agg-syntax]
1313

14-
`buckets_path`
15-
: (Required, string) Path to the buckets that contain one set of values to correlate. For syntax, see [`buckets_path` Syntax](/reference/aggregations/pipeline.md#buckets-path-syntax).
14+
### `buckets_path`
1615

17-
`function`
18-
: (Required, object) The correlation function to execute.
16+
(Required, string) Path to the buckets that contain one set of values to correlate. For syntax, see [`buckets_path` Syntax](/reference/aggregations/pipeline.md#buckets-path-syntax).
1917

20-
::::{dropdown} Properties of `function`
21-
`count_correlation`
22-
: (Required*, object) The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. Consequently, it needs to meet the following requirements.
18+
### `function`
2319

24-
* The `buckets_path` must point to a `_count` metric.
25-
* The total count of all the `bucket_path` count values must be less than or equal to `indicator.doc_count`.
26-
* When utilizing this function, an initial calculation to gather the required `indicator` values is required.
20+
(Required, object) The correlation function to execute.
2721

28-
::::{dropdown} Properties of `count_correlation`
29-
`indicator`
30-
: (Required, object) The indicator with which to correlate the configured `bucket_path` values.
22+
#### `count_correlation`
3123

32-
::::{dropdown} Properties of `indicator`
33-
`doc_count`
34-
: (Required, integer) The total number of documents that initially created the `expectations`. It’s required to be greater than or equal to the sum of all values in the `buckets_path` as this is the originating superset of data to which the term values are correlated.
24+
(Required*, object) The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. Consequently, it needs to meet the following requirements.
3525

36-
`expectations`
37-
: (Required, array) An array of numbers with which to correlate the configured `bucket_path` values. The length of this value must always equal the number of buckets returned by the `bucket_path`.
26+
* The `buckets_path` must point to a `_count` metric.
27+
* The total count of all the `bucket_path` count values must be less than or equal to `indicator.doc_count`.
28+
* When utilizing this function, an initial calculation to gather the required `indicator` values is required.
3829

39-
`fractions`
40-
: (Optional, array) An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the `buckets_path` have known gaps. The length of `fractions`, if provided, must equal `expectations`.
30+
`indicator`
31+
: (Required, object) The indicator with which to correlate the configured `bucket_path` values.
4132

42-
::::
43-
44-
45-
::::
46-
47-
48-
::::
33+
`doc_count`
34+
: (Required, integer) The total number of documents that initially created the `expectations`. It’s required to be greater than or equal to the sum of all values in the `buckets_path` as this is the originating superset of data to which the term values are correlated.
4935

36+
`expectations`
37+
: (Required, array) An array of numbers with which to correlate the configured `bucket_path` values. The length of this value must always equal the number of buckets returned by the `bucket_path`.
5038

39+
`fractions`
40+
: (Optional, array) An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the `buckets_path` have known gaps. The length of `fractions`, if provided, must equal `expectations`.
5141

5242
## Syntax [_syntax_8]
5343

docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Picking a free-text field as the subject of a significant terms analysis can be
196196
::::
197197

198198

199-
::::{admonition} Use the *"like this but not this"* pattern
199+
::::{admonition} Use the "like this but not this" pattern
200200
You can spot mis-categorized content by first searching a structured field e.g. `category:adultMovie` and use significant_terms on the free-text "movie_description" field. Take the suggested words (I’ll leave them to your imagination) and then search for all movies NOT marked as category:adultMovie but containing these keywords. You now have a ranked list of badly-categorized movies that you should reclassify or at least remove from the "familyFriendly" category.
201201

202202
The significance score from each term can also provide a useful `boost` setting to sort matches. Using the `minimum_should_match` setting of the `terms` query with the keywords will help control the balance of precision/recall in the result set i.e a high setting would have a small number of relevant results packed full of keywords and a setting of "1" would produce a more exhaustive results set with all documents containing *any* keyword.

docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ The numbers returned for scores are primarily intended for ranking different sug
265265
::::
266266
267267
268-
::::{admonition} Use the *"like this but not this"* pattern
268+
::::{admonition} Use the "like this but not this" pattern
269269
You can spot mis-categorized content by first searching a structured field e.g. `category:adultMovie` and use significant_text on the text "movie_description" field. Take the suggested words (I’ll leave them to your imagination) and then search for all movies NOT marked as category:adultMovie but containing these keywords. You now have a ranked list of badly-categorized movies that you should reclassify or at least remove from the "familyFriendly" category.
270270
271271
The significance score from each term can also provide a useful `boost` setting to sort matches. Using the `minimum_should_match` setting of the `terms` query with the keywords will help control the balance of precision/recall in the result set i.e a high setting would have a small number of relevant results packed full of keywords and a setting of "1" would produce a more exhaustive results set with all documents containing *any* keyword.

docs/reference/aggregations/search-aggregations-change-point-aggregation.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,14 @@ A `change_point` aggregation looks like this in isolation:
4646
`bucket`
4747
: (Optional, object) Values of the bucket that indicates the discovered change point. Not returned if no change point was found. All the aggregations in the bucket are returned as well.
4848

49-
::::{dropdown} Properties of bucket
49+
**Properties of `bucket**:
50+
5051
`key`
5152
: (value) The key of the bucket matched. Could be string or numeric.
5253

5354
`doc_count`
5455
: (number) The document count of the bucket.
5556

56-
::::
57-
5857

5958
`type`
6059
: (object) The found change point type and its related values. Possible types:

docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ POST /places/_search?size=0
201201
}
202202
```
203203

204-
::::{admonition} Using `geo_centroid` as a sub-aggregation of `geohash_grid`
204+
::::{admonition} Using geo_centroid as a sub-aggregation of geohash_grid
205205
:class: warning
206206

207207
The [`geohash_grid`](/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation.md) aggregation places documents, not individual geopoints, into buckets. If a document’s `geo_point` field contains [multiple values](/reference/elasticsearch/mapping-reference/array.md), the document could be assigned to multiple buckets, even if one or more of its geopoints are outside the bucket boundaries.

docs/reference/aggregations/search-aggregations-metrics-max-aggregation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ mapped_pages:
1010
A `single-value` metrics aggregation that keeps track and returns the maximum value among the numeric values extracted from the aggregated documents.
1111

1212
::::{note}
13-
The `min` and `max` aggregation operate on the `double` representation of the data. As a consequence, the result may be approximate when running on longs whose absolute value is greater than `2`^`53`^.
13+
The `min` and `max` aggregation operate on the `double` representation of the data. As a consequence, the result may be approximate when running on longs whose absolute value is greater than `2^53`.
1414
::::
1515

1616

docs/reference/aggregations/search-aggregations-metrics-min-aggregation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ mapped_pages:
1010
A `single-value` metrics aggregation that keeps track and returns the minimum value among numeric values extracted from the aggregated documents.
1111

1212
::::{note}
13-
The `min` and `max` aggregation operate on the `double` representation of the data. As a consequence, the result may be approximate when running on longs whose absolute value is greater than `2`^`53`^.
13+
The `min` and `max` aggregation operate on the `double` representation of the data. As a consequence, the result may be approximate when running on longs whose absolute value is greater than `2^53`.
1414
::::
1515

1616

docs/reference/elasticsearch-plugins/analysis-icu.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ While we restrict ICU upgrades to major versions, you may find that an index cre
2020

2121
## Installation [analysis-icu-install]
2222

23-
::::{warning}
24-
Version 9.0.0-beta1 of the Elastic Stack has not yet been released. The plugin might not be available.
25-
::::
26-
27-
2823
This plugin can be installed using the plugin manager:
2924

3025
```sh
@@ -33,7 +28,7 @@ sudo bin/elasticsearch-plugin install analysis-icu
3328

3429
The plugin must be installed on every node in the cluster, and each node must be restarted after installation.
3530

36-
You can download this plugin for [offline install](/reference/elasticsearch-plugins/plugin-management-custom-url.md) from [https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-9.0.0-beta1.zip](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-9.0.0-beta1.zip). To verify the `.zip` file, use the [SHA hash](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-9.0.0-beta1.zip.sha512) or [ASC key](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-9.0.0-beta1.zip.asc).
31+
You can download this plugin for [offline install](/reference/elasticsearch-plugins/plugin-management-custom-url.md) from [https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-{{version}}.zip](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-{{version}}.zip). To verify the `.zip` file, use the [SHA hash](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-{{version}}.zip.sha512) or [ASC key](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-{{version}}.zip.asc).
3732

3833

3934
## Removal [analysis-icu-remove]

docs/reference/elasticsearch-plugins/analysis-kuromoji.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ The Japanese (kuromoji) analysis plugin integrates Lucene kuromoji analysis modu
1010

1111
## Installation [analysis-kuromoji-install]
1212

13-
::::{warning}
14-
Version 9.0.0-beta1 of the Elastic Stack has not yet been released. The plugin might not be available.
15-
::::
16-
17-
1813
This plugin can be installed using the plugin manager:
1914

2015
```sh
@@ -23,7 +18,7 @@ sudo bin/elasticsearch-plugin install analysis-kuromoji
2318

2419
The plugin must be installed on every node in the cluster, and each node must be restarted after installation.
2520

26-
You can download this plugin for [offline install](/reference/elasticsearch-plugins/plugin-management-custom-url.md) from [https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-kuromoji/analysis-kuromoji-9.0.0-beta1.zip](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-kuromoji/analysis-kuromoji-9.0.0-beta1.zip). To verify the `.zip` file, use the [SHA hash](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-kuromoji/analysis-kuromoji-9.0.0-beta1.zip.sha512) or [ASC key](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-kuromoji/analysis-kuromoji-9.0.0-beta1.zip.asc).
21+
You can download this plugin for [offline install](/reference/elasticsearch-plugins/plugin-management-custom-url.md) from [https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-kuromoji/analysis-kuromoji-{{version}}.zip](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-kuromoji/analysis-kuromoji-{{version}}.zip). To verify the `.zip` file, use the [SHA hash](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-kuromoji/analysis-kuromoji-{{version}}.zip.sha512) or [ASC key](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-kuromoji/analysis-kuromoji-{{version}}.zip.asc).
2722

2823

2924
## Removal [analysis-kuromoji-remove]

docs/reference/elasticsearch-plugins/analysis-nori.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ The Korean (nori) Analysis plugin integrates Lucene nori analysis module into el
1010

1111
## Installation [analysis-nori-install]
1212

13-
::::{warning}
14-
Version 9.0.0-beta1 of the Elastic Stack has not yet been released. The plugin might not be available.
15-
::::
16-
17-
1813
This plugin can be installed using the plugin manager:
1914

2015
```sh
@@ -23,7 +18,7 @@ sudo bin/elasticsearch-plugin install analysis-nori
2318

2419
The plugin must be installed on every node in the cluster, and each node must be restarted after installation.
2520

26-
You can download this plugin for [offline install](/reference/elasticsearch-plugins/plugin-management-custom-url.md) from [https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-nori/analysis-nori-9.0.0-beta1.zip](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-nori/analysis-nori-9.0.0-beta1.zip). To verify the `.zip` file, use the [SHA hash](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-nori/analysis-nori-9.0.0-beta1.zip.sha512) or [ASC key](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-nori/analysis-nori-9.0.0-beta1.zip.asc).
21+
You can download this plugin for [offline install](/reference/elasticsearch-plugins/plugin-management-custom-url.md) from [https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-nori/analysis-nori-{{version}}.zip](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-nori/analysis-nori-{{version}}.zip). To verify the `.zip` file, use the [SHA hash](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-nori/analysis-nori-{{version}}.zip.sha512) or [ASC key](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-nori/analysis-nori-{{version}}.zip.asc).
2722

2823

2924
## Removal [analysis-nori-remove]

docs/reference/elasticsearch-plugins/analysis-phonetic.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ The Phonetic Analysis plugin provides token filters which convert tokens to thei
1010

1111
## Installation [analysis-phonetic-install]
1212

13-
::::{warning}
14-
Version 9.0.0-beta1 of the Elastic Stack has not yet been released. The plugin might not be available.
15-
::::
16-
17-
1813
This plugin can be installed using the plugin manager:
1914

2015
```sh
@@ -23,7 +18,7 @@ sudo bin/elasticsearch-plugin install analysis-phonetic
2318

2419
The plugin must be installed on every node in the cluster, and each node must be restarted after installation.
2520

26-
You can download this plugin for [offline install](/reference/elasticsearch-plugins/plugin-management-custom-url.md) from [https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-phonetic/analysis-phonetic-9.0.0-beta1.zip](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-phonetic/analysis-phonetic-9.0.0-beta1.zip). To verify the `.zip` file, use the [SHA hash](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-phonetic/analysis-phonetic-9.0.0-beta1.zip.sha512) or [ASC key](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-phonetic/analysis-phonetic-9.0.0-beta1.zip.asc).
21+
You can download this plugin for [offline install](/reference/elasticsearch-plugins/plugin-management-custom-url.md) from [https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-phonetic/analysis-phonetic-{{version}}.zip](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-phonetic/analysis-phonetic-{{version}}.zip). To verify the `.zip` file, use the [SHA hash](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-phonetic/analysis-phonetic-{{version}}.zip.sha512) or [ASC key](https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-phonetic/analysis-phonetic-{{version}}.zip.asc).
2722

2823

2924
## Removal [analysis-phonetic-remove]

0 commit comments

Comments
 (0)