Skip to content

Commit

Permalink
Backport doc fixes to 7.17 (#84722)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>

* [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 <[email protected]>

* 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 <[email protected]>

Co-authored-by: jalvar08 <[email protected]>
Co-authored-by: er0k <[email protected]>
Co-authored-by: Abele Mălan <[email protected]>
  • Loading branch information
4 people authored Mar 7, 2022
1 parent e5243e7 commit 17f5cc8
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/analysis-icu.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/plugin-script.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/keystore.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ names can be specified as arguments to the `remove` command.
`show <setting>`:: 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/fleet/fleet-search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/shrink-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<indices-forcemerge,force-merging>> the shard to a single
segment.

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/setup/install/deb.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand All @@ -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::[]
Expand All @@ -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::[]
Expand Down

0 comments on commit 17f5cc8

Please sign in to comment.