Browse Source

Provide links to auto-follow docs (#35674)

This commit adds a link to the auto-follow docs from the CCR getting
started docs and the relevant CCR APIs.
Jason Tedor 6 years ago
parent
commit
220c175484

+ 2 - 1
docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc

@@ -12,7 +12,8 @@ Delete auto-follow patterns.
 
 ==== Description
 
-This API deletes a configured auto-follow pattern collection.
+This API deletes a configured collection of
+{stack-ov}/ccr-auto-follow.html[auto-follow patterns].
 
 ==== Request
 

+ 2 - 2
docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc

@@ -12,8 +12,8 @@ Get auto-follow patterns.
 
 ==== Description
 
-This API gets configured auto-follow patterns. This API will return the
-specified auto-follow pattern collection.
+This API gets configured {stack-ov}/ccr-auto-follow.html[auto-follow patterns].
+This API will return the specified auto-follow pattern collection.
 
 ==== Request
 

+ 5 - 4
docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc

@@ -12,10 +12,11 @@ Creates an auto-follow pattern.
 
 ==== Description
 
-This API creates a new named collection of auto-follow patterns against the
-remote cluster specified in the request body. Newly created indices on the
-remote cluster matching any of the specified patterns will be automatically
-configured as follower indices.
+This API creates a new named collection of
+{stack-ov}/ccr-auto-follow.html[auto-follow patterns] against the remote cluster
+specified in the request body. Newly created indices on the remote cluster
+matching any of the specified patterns will be automatically configured as follower
+indices.
 
 ==== Request
 

+ 1 - 1
docs/reference/ccr/auto-follow.asciidoc

@@ -1,6 +1,6 @@
 [role="xpack"]
 [testenv="platinum"]
-[[ccr-overview-auto-follow]]
+[[ccr-auto-follow]]
 === Automatically following indices
 
 beta[]

+ 5 - 5
docs/reference/ccr/getting-started.asciidoc

@@ -274,11 +274,11 @@ POST /server-metrics-copy/_ccr/unfollow
 [[ccr-getting-started-auto-follow]]
 === Automatically create follower indices
 
-The auto-follow feature in {ccr} helps for time series use cases where you want
-to follow new indices that are periodically created in the remote cluster
-(such as daily Beats indices). Auto-following is configured using the
-{ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. With an
-auto-follow pattern, you reference the
+The <<ccr-auto-follow,auto-follow>> feature in {ccr} helps for time series use
+cases where you want to follow new indices that are periodically created in the
+remote cluster (such as daily Beats indices). Auto-following is configured using
+the {ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. With
+an auto-follow pattern, you reference the
 <<ccr-getting-started-remote-cluster,remote cluster>> that you connected your
 local cluster to. You must also specify a collection of  patterns that match the
 indices you want to automatically follow.

+ 3 - 2
docs/reference/ccr/index.asciidoc

@@ -9,7 +9,8 @@
 beta[]
 
 The {ccr} (CCR) feature enables replication of indices in remote clusters to a 
-local cluster. This functionality can be used in some common production use cases:
+local cluster. This functionality can be used in some common production use
+cases:
 
 * Disaster recovery in case a primary cluster fails. A secondary cluster can
   serve as a hot backup
@@ -19,7 +20,7 @@ This guide provides an overview of {ccr}:
 
 * <<ccr-overview>>
 * <<ccr-requirements>>
-* <<ccr-overview-auto-follow>>
+* <<ccr-auto-follow>>
 * <<ccr-getting-started>>
 
 --

+ 1 - 1
docs/reference/ccr/overview.asciidoc

@@ -27,7 +27,7 @@ Replication can be configured in two ways:
   {ref}/ccr-put-follow.html[create follower API]
 
 * Automatically using
-  <<ccr-overview-auto-follow,auto-follow patterns>>
+  <<ccr-auto-follow,auto-follow patterns>>
 
 NOTE: You must also <<ccr-requirements,configure the leader index>>.