Skip to content

Commit 43ef469

Browse files
authored
[DOCS] Relocate indices module content (#54903) (#57413)
Moves `indices` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Also removes the [Indices][2] landing page and adds a related redirect. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-indices.html
1 parent 25f6954 commit 43ef469

11 files changed

+39
-64
lines changed

docs/reference/modules.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,6 @@ include::modules/gateway.asciidoc[]
7979

8080
include::modules/http.asciidoc[]
8181

82-
include::modules/indices.asciidoc[]
83-
8482
include::modules/network.asciidoc[]
8583

8684
include::modules/node.asciidoc[]

docs/reference/modules/indices.asciidoc

Lines changed: 0 additions & 50 deletions
This file was deleted.

docs/reference/modules/indices/circuit_breaker.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[circuit-breaker]]
2-
=== Circuit Breaker
2+
=== Circuit breaker settings
33

44
Elasticsearch contains multiple circuit breakers used to prevent operations from
55
causing an OutOfMemoryError. Each breaker specifies a limit for how much memory

docs/reference/modules/indices/fielddata.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[modules-fielddata]]
2-
=== Fielddata
2+
=== Field data cache settings
33

44
The field data cache is used mainly when sorting on or computing aggregations
55
on a field. It loads all the field values to memory in order to provide fast

docs/reference/modules/indices/indexing_buffer.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[indexing-buffer]]
2-
=== Indexing Buffer
2+
=== Indexing buffer settings
33

44
The indexing buffer is used to store newly indexed documents. When it fills
55
up, the documents in the buffer are written to a segment on disk. It is divided

docs/reference/modules/indices/query_cache.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[query-cache]]
2-
=== Node Query Cache
2+
=== Node query cache settings
33

44
The results of queries used in the filter context are cached in the node query
55
cache for fast lookup. There is one queries cache per node that is shared by all

docs/reference/modules/indices/recovery.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[recovery]]
2-
=== Index recovery
2+
=== Index recovery settings
33

44
Peer recovery syncs data from a primary shard to a new or existing shard copy.
55

docs/reference/modules/indices/request_cache.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[shard-request-cache]]
2-
=== Shard request cache
2+
=== Shard request cache settings
33

44
When a search request is run against an index or against many indices, each
55
involved shard executes the search locally and returns its local results to

docs/reference/modules/indices/search-settings.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[search-settings]]
2-
=== Search Settings
2+
=== Search settings
33

44
The following expert settings can be set to manage global search and aggregation
55
limits.

docs/reference/redirects.asciidoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -615,6 +615,19 @@ See <<ccs-gateway-seed-nodes>> and <<ccs-min-roundtrips>>.
615615
See <<indices-create-data-stream>>, <<indices-get-data-stream>>, and
616616
<<indices-delete-data-stream>>.
617617

618+
[role="exclude",id="modules-indices"]
619+
=== Indices module
620+
621+
See:
622+
623+
* <<circuit-breaker>>
624+
* <<indexing-buffer>>
625+
* <<modules-fielddata>>
626+
* <<query-cache>>
627+
* <<recovery>>
628+
* <<search-settings>>
629+
* <<shard-request-cache>>
630+
618631
[role="exclude",id="cat-transform"]
619632
=== cat transform API
620633

@@ -799,4 +812,4 @@ See <<query-filter-context>>.
799812
We have stopped adding new customers to our {esms}.
800813

801814
If you are interested in similar capabilities, contact
802-
https://support.elastic.co[Elastic Support] to discuss available options.
815+
https://support.elastic.co[Elastic Support] to discuss available options.

docs/reference/setup.asciidoc

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,36 @@ include::setup/jvm-options.asciidoc[]
4545

4646
include::setup/secure-settings.asciidoc[]
4747

48-
include::setup/logging-config.asciidoc[]
48+
include::settings/ccr-settings.asciidoc[]
4949

50-
include::settings/audit-settings.asciidoc[]
50+
include::modules/indices/circuit_breaker.asciidoc[]
5151

52-
include::settings/ccr-settings.asciidoc[]
52+
include::modules/indices/recovery.asciidoc[]
53+
54+
include::modules/indices/indexing_buffer.asciidoc[]
55+
56+
include::modules/indices/fielddata.asciidoc[]
5357

5458
include::settings/ilm-settings.asciidoc[]
5559

5660
include::settings/license-settings.asciidoc[]
5761

62+
include::setup/logging-config.asciidoc[]
63+
5864
include::settings/ml-settings.asciidoc[]
5965

6066
include::settings/monitoring-settings.asciidoc[]
6167

68+
include::modules/indices/query_cache.asciidoc[]
69+
70+
include::modules/indices/request_cache.asciidoc[]
71+
72+
include::modules/indices/search-settings.asciidoc[]
73+
6274
include::settings/security-settings.asciidoc[]
6375

76+
include::settings/audit-settings.asciidoc[]
77+
6478
include::settings/slm-settings.asciidoc[]
6579

6680
include::settings/sql-settings.asciidoc[]
@@ -81,4 +95,4 @@ include::setup/stopping.asciidoc[]
8195

8296
include::setup/add-nodes.asciidoc[]
8397

84-
include::setup/restart-cluster.asciidoc[]
98+
include::setup/restart-cluster.asciidoc[]

0 commit comments

Comments
 (0)