From 17f5cc87bd31c38c5410f77586d4b39b5bbdced6 Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Mon, 7 Mar 2022 14:04:12 -0500 Subject: [PATCH] Backport doc fixes to 7.17 (#84722) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update painless-reindex-context.asciidoc (#84444) (#84712) ctx['op'] should be set to 'noop', not 'none' when specifying no operation. Elasticsearch error when using 'none': ```json { "error" : { "root_cause" : [ { "type" : "illegal_argument_exception", "reason" : "Operation type [none] not allowed, only [noop, index, delete] are allowed" } ], "type" : "illegal_argument_exception", "reason" : "Operation type [none] not allowed, only [noop, index, delete] are allowed" }, "status" : 400 } ``` Co-authored-by: jalvar08 * [DOCS] Update install instructions for Debian/Ubuntu (#84645) (#84714) The use of `apt-key` is deprecated and will no longer be available after Debian 11 and Ubuntu 22.04. This updates the installation instructions for Debian-based distributions. Closes #84644 Co-authored-by: er0k * Fix some typos in plugins & reference docs (#84667) (#84717) This pull request removes a few instances of duplicate words or punctuation and erroneous spelling from the docs. Co-authored-by: Abele Mălan <6689720+AbeleMM@users.noreply.github.com> Co-authored-by: jalvar08 Co-authored-by: er0k Co-authored-by: Abele Mălan <6689720+AbeleMM@users.noreply.github.com> --- .../painless-contexts/painless-reindex-context.asciidoc | 2 +- docs/plugins/analysis-icu.asciidoc | 2 +- docs/plugins/plugin-script.asciidoc | 2 +- .../bucket/variablewidthhistogram-aggregation.asciidoc | 2 +- .../tokenfilters/synonym-graph-tokenfilter.asciidoc | 2 +- docs/reference/commands/keystore.asciidoc | 2 +- docs/reference/fleet/fleet-search.asciidoc | 2 +- docs/reference/indices/shrink-index.asciidoc | 2 +- docs/reference/setup/install/deb.asciidoc | 6 +++--- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/painless/painless-contexts/painless-reindex-context.asciidoc b/docs/painless/painless-contexts/painless-reindex-context.asciidoc index 4ecf17f6cb7b6..ce7e3cd37f3ff 100644 --- a/docs/painless/painless-contexts/painless-reindex-context.asciidoc +++ b/docs/painless/painless-contexts/painless-reindex-context.asciidoc @@ -35,7 +35,7 @@ reindexed into a target index. *Side Effects* `ctx['op']`:: - Use the default of `index` to update a document. Set to `none` to + Use the default of `index` to update a document. Set to `noop` to specify no operation or `delete` to delete the current document from the index. diff --git a/docs/plugins/analysis-icu.asciidoc b/docs/plugins/analysis-icu.asciidoc index ac5a32a3b5351..3e6612dd8f4c8 100644 --- a/docs/plugins/analysis-icu.asciidoc +++ b/docs/plugins/analysis-icu.asciidoc @@ -442,7 +442,7 @@ unless otherwise specified in the collation. Possible values: `no` (default, but collation-dependent) or `canonical`. Setting this decomposition property to `canonical` allows the Collator to handle unnormalized text properly, producing the same results as if the text -were normalized. If `no` is set, it is the user's responsibility to insure +were normalized. If `no` is set, it is the user's responsibility to ensure that all text is already in the appropriate form before a comparison or before getting a CollationKey. Adjusting decomposition mode allows the user to select between faster and more complete collation behavior. Since a great many of the diff --git a/docs/plugins/plugin-script.asciidoc b/docs/plugins/plugin-script.asciidoc index c0d1956a44678..75885cb8085af 100644 --- a/docs/plugins/plugin-script.asciidoc +++ b/docs/plugins/plugin-script.asciidoc @@ -302,7 +302,7 @@ plugin configuration file. If you run {es} using Docker, you can manage plugins using a declarative configuration file. When {es} starts up, it will compare the plugins in the file with those that are currently installed, and add or remove plugins as required. {es} -will also upgrade offical plugins when you upgrade {es} itself. +will also upgrade official plugins when you upgrade {es} itself. The file is called `elasticsearch-plugins.yml`, and must be placed in the Elasticsearch configuration directory, alongside `elasticsearch.yml`. Here diff --git a/docs/reference/aggregations/bucket/variablewidthhistogram-aggregation.asciidoc b/docs/reference/aggregations/bucket/variablewidthhistogram-aggregation.asciidoc index e90093c24a88a..d6d7bbf432546 100644 --- a/docs/reference/aggregations/bucket/variablewidthhistogram-aggregation.asciidoc +++ b/docs/reference/aggregations/bucket/variablewidthhistogram-aggregation.asciidoc @@ -74,7 +74,7 @@ TIP: A shard can return fewer than `shard_size` buckets, but it cannot return mo ==== Shard size The `shard_size` parameter specifies the number of buckets that the coordinating node will request from each shard. -A higher `shard_size` leads each shard to produce smaller buckets. This reduce the likelihood of buckets overlapping +A higher `shard_size` leads each shard to produce smaller buckets. This reduces the likelihood of buckets overlapping after the reduction step. Increasing the `shard_size` will improve the accuracy of the histogram, but it will also make it more expensive to compute the final result because bigger priority queues will have to be managed on a shard level, and the data transfers between the nodes and the client will be larger. diff --git a/docs/reference/analysis/tokenfilters/synonym-graph-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/synonym-graph-tokenfilter.asciidoc index bb53a9d718749..209d42c5a0d83 100644 --- a/docs/reference/analysis/tokenfilters/synonym-graph-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/synonym-graph-tokenfilter.asciidoc @@ -99,7 +99,7 @@ stop word. ==== `tokenizer` and `ignore_case` are deprecated The `tokenizer` parameter controls the tokenizers that will be used to -tokenize the synonym, this parameter is for backwards compatibility for indices that created before 6.0.. +tokenize the synonym, this parameter is for backwards compatibility for indices that created before 6.0. The `ignore_case` parameter works with `tokenizer` parameter only. Two synonym formats are supported: Solr, WordNet. diff --git a/docs/reference/commands/keystore.asciidoc b/docs/reference/commands/keystore.asciidoc index a8e542cb8e52d..3ee7ce9af17c8 100644 --- a/docs/reference/commands/keystore.asciidoc +++ b/docs/reference/commands/keystore.asciidoc @@ -91,7 +91,7 @@ names can be specified as arguments to the `remove` command. `show `:: Displays the value of a single setting in the keystore. Pass the `-o` (or `--output`) parameter to write the setting to a file. If writing to the standard output (the terminal) the setting's value is always -interpretted as a UTF-8 string. If the setting contains binary data (for example +interpreted as a UTF-8 string. If the setting contains binary data (for example for data that was added via the `add-file` command), always use the `-o` option to write to a file. diff --git a/docs/reference/fleet/fleet-search.asciidoc b/docs/reference/fleet/fleet-search.asciidoc index 68908308363f1..961846385969a 100644 --- a/docs/reference/fleet/fleet-search.asciidoc +++ b/docs/reference/fleet/fleet-search.asciidoc @@ -23,7 +23,7 @@ only be executed on local shards after the all operations up to and including th sequence number checkpoint are visible for search. Indexed operations become visible after a refresh. The checkpoints are indexed by shard. -If a timeout occurs before the the checkpoint has been refreshed into Elasticsearch, +If a timeout occurs before the checkpoint has been refreshed into Elasticsearch, the search request will timeout. The fleet search API only supports searches against a single target. If an index alias diff --git a/docs/reference/indices/shrink-index.asciidoc b/docs/reference/indices/shrink-index.asciidoc index 01333862c45d4..9ebc6ff5ef5a5 100644 --- a/docs/reference/indices/shrink-index.asciidoc +++ b/docs/reference/indices/shrink-index.asciidoc @@ -171,7 +171,7 @@ POST /my_source_index/_shrink/my_target_index <1> The number of shards in the target index. This must be a factor of the number of shards in the source index. -<2> Best compression will only take affect when new writes are made to the +<2> Best compression will only take effect when new writes are made to the index, such as when <> the shard to a single segment. diff --git a/docs/reference/setup/install/deb.asciidoc b/docs/reference/setup/install/deb.asciidoc index 3eb804f457b49..32847576db703 100644 --- a/docs/reference/setup/install/deb.asciidoc +++ b/docs/reference/setup/install/deb.asciidoc @@ -22,7 +22,7 @@ include::key.asciidoc[] [source,sh] ------------------------- -wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add - +wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo gpg --dearmor -o /usr/share/keyrings/elasticsearch-keyring.gpg ------------------------- [[deb-repo]] @@ -49,7 +49,7 @@ ifeval::["{release-state}"=="released"] ["source","sh",subs="attributes,callouts"] -------------------------------------------------- -echo "deb https://artifacts.elastic.co/packages/{major-version}/apt stable main" | sudo tee /etc/apt/sources.list.d/elastic-{major-version}.list +echo "deb [signed-by=/usr/share/keyrings/elasticsearch-keyring.gpg] https://artifacts.elastic.co/packages/{major-version}/apt stable main" | sudo tee /etc/apt/sources.list.d/elastic-{major-version}.list -------------------------------------------------- endif::[] @@ -58,7 +58,7 @@ ifeval::["{release-state}"=="prerelease"] ["source","sh",subs="attributes,callouts"] -------------------------------------------------- -echo "deb https://artifacts.elastic.co/packages/{major-version}-prerelease/apt stable main" | sudo tee /etc/apt/sources.list.d/elastic-{major-version}.list +echo "deb [signed-by=/usr/share/keyrings/elasticsearch-keyring.gpg] https://artifacts.elastic.co/packages/{major-version}-prerelease/apt stable main" | sudo tee /etc/apt/sources.list.d/elastic-{major-version}.list -------------------------------------------------- endif::[]