Skip to content

Commit a635eca

Browse files
committed
Retitle and relocate cross-cluster search docs (#45608)
1 parent ec41825 commit a635eca

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

docs/reference/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ include::aggregations.asciidoc[]
3232

3333
include::query-dsl.asciidoc[]
3434

35+
include::modules/cross-cluster-search.asciidoc[]
36+
3537
include::scripting.asciidoc[]
3638

3739
include::mapping.asciidoc[]

docs/reference/modules.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,3 @@ include::modules/threadpool.asciidoc[]
9898
include::modules/transport.asciidoc[]
9999

100100
include::modules/remote-clusters.asciidoc[]
101-
102-
include::modules/cross-cluster-search.asciidoc[]

docs/reference/modules/cross-cluster-search.asciidoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
[chapter]
12
[[modules-cross-cluster-search]]
2-
== {ccs-cap}
3+
= Search across clusters
34

45
*{ccs-cap}* lets you run a single search request against one or more
56
<<modules-remote-clusters,remote clusters>>. For example, you can use a {ccs} to
@@ -9,11 +10,11 @@ IMPORTANT: {ccs-cap} requires <<modules-remote-clusters, remote clusters>>.
910

1011
[float]
1112
[[ccs-example]]
12-
=== {ccs-cap} examples
13+
== {ccs-cap} examples
1314

1415
[float]
1516
[[ccs-remote-cluster-setup]]
16-
==== Remote cluster setup
17+
=== Remote cluster setup
1718

1819
To perform a {ccs}, you must have at least one remote cluster configured.
1920

@@ -53,7 +54,7 @@ PUT _cluster/settings
5354

5455
[float]
5556
[[ccs-search-remote-cluster]]
56-
==== Search a single remote cluster
57+
=== Search a single remote cluster
5758

5859
The following <<search,search>> API request searches the
5960
`twitter` index on a single remote cluster, `cluster_one`.
@@ -123,7 +124,7 @@ The API returns the following response:
123124

124125
[float]
125126
[[ccs-search-multi-remote-cluster]]
126-
==== Search multiple remote clusters
127+
=== Search multiple remote clusters
127128

128129
The following <<search,search>> API request searches the `twitter` index on
129130
three clusters:
@@ -223,7 +224,7 @@ means the document came from the local cluster.
223224

224225
[float]
225226
[[skip-unavailable-clusters]]
226-
=== Skip unavailable clusters
227+
== Skip unavailable clusters
227228

228229
By default, a {ccs} returns an error if *any* cluster in the request is
229230
unavailable.
@@ -251,7 +252,7 @@ include matching documents from that cluster in the final results.
251252

252253
[float]
253254
[[ccs-works]]
254-
=== How {ccs} works
255+
== How {ccs} works
255256
Because {ccs} involves sending requests to remote clusters, any network delays
256257
can impact search speed. To avoid slow searches, {ccs} offers two options for
257258
handling network delays:
@@ -279,7 +280,7 @@ See <<ccs-unmin-roundtrips>> to learn how this option works.
279280

280281
[float]
281282
[[ccs-min-roundtrips]]
282-
==== Minimize network roundtrips
283+
=== Minimize network roundtrips
283284

284285
Here's how {ccs} works when you minimize network roundtrips.
285286

@@ -304,7 +305,7 @@ image:images/ccs/ccs-min-roundtrip-client-response.png[]
304305

305306
[float]
306307
[[ccs-unmin-roundtrips]]
307-
==== Don't minimize network roundtrips
308+
=== Don't minimize network roundtrips
308309

309310
Here's how {ccs} works when you don't minimize network roundtrips.
310311

0 commit comments

Comments
 (0)