Apply feedback

Author: jasontedor

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

@@ -10,7 +10,7 @@ Delete auto-follow patterns.
 
 ==== Description
 
-This API deletes configured auto-follow patterns.
+This API deletes a configured auto-follow pattern collection.
 
 ==== Request
 
@@ -41,13 +41,14 @@ DELETE /_ccr/auto_follow/<auto_follow_pattern_name>
 // CONSOLE
 // TEST[s/<auto_follow_pattern_name>/my_auto_follow_pattern/]
 
-Here, the auto-follow patterns associated with the
-<<modules-remote-clusters,remote cluster>> specified by `<leader_cluster>`
-will be deleted.
+==== Path Components
+`auto_follow_pattern_name` (required)::
+  (string) specifies the auto-follow pattern collection to delete
 
 ==== Example
 
-The following is an example of using the delete auto-follow pattern API.
+This example deletes an auto-follow pattern collection named
+`my_auto_follow_pattern`:
 
 [source,js]
 --------------------------------------------------

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

@@ -49,21 +49,23 @@ GET /_ccr/auto_follow/
 --------------------------------------------------
 // CONSOLE
 
-Here, all auto-follow patterns will be returned.
-
 [source,js]
 --------------------------------------------------
 GET /_ccr/auto_follow/<auto_follow_pattern_name>
 --------------------------------------------------
 // CONSOLE
 // TEST[s/<auto_follow_pattern_name>/my_auto_follow_pattern/]
 
-Here, the named auto-follow pattern collection specified by
-`<auto_follow_pattern_name>` will be returned.
+==== Path Components
+`auto_follow_pattern_name`::
+  (string) specifies the auto-follow pattern collection that you want to
+  retrieve; if you do not specify a name, the API returns information for all
+  collections
 
 ==== Example
 
-The following is an example of using the get auto-follow pattern API.
+This example retrieves information about an auto-follow pattern collection
+named `my_auto_follow_pattern`:
 
 [source,js]
 --------------------------------------------------

docs/reference/ccr/apis/auto-follow/get-auto-follow-stats.asciidoc

@@ -21,11 +21,9 @@ GET /_ccr/auto_follow/stats
 // CONSOLE
 // TEST
 
-Here, stats about auto-follow patterns will be returned.
-
 ==== Example
 
-The following is an example of using the get auto-follow stats API.
+This example retrieves stats about auto-follow patterns:
 
 [source,js]
 --------------------------------------------------

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

@@ -47,14 +47,9 @@ DELETE /_ccr/auto_follow/auto_follow_pattern_name
 
 //////////////////////////
 
-Here, `<auto_follow_pattern_name>` is a user-chosen name for the collection of
-auto-follow patterns being created, `<leader_cluster>` is the
-<<modules-remote-clusters,remote cluster>> containing the leader indices to
-match against, `<leader_index_pattern>` is a simple index pattern to match
-against indices in the remote cluster, and `<follow_index_pattern>` is the
-pattern to use to name the resulting follower indices. The
-`<follow_index_pattern>` can use the template `{{leader_index}}` to refer to the
-name of the leader index being followed.
+==== Path Components
+`auto_follow_pattern_name` (required)::
+  (string) name of the collection of auto-follow patterns
 
 ==== Request Body
 `leader_cluster`::
@@ -74,7 +69,7 @@ include::../follow-request-body.asciidoc[]
 
 ==== Example
 
-The following is an example of using the create auto-follow pattern API.
+This example creates an auto-follow pattern named `my_auto_follow_pattern`:
 
 [source,js]
 --------------------------------------------------

docs/reference/ccr/apis/follow/get-follow-stats.asciidoc

@@ -43,9 +43,6 @@ POST /follower_index/_ccr/pause_follow
 GET /_ccr/stats
 --------------------------------------------------
 // CONSOLE
-// TEST
-
-Here, all follower indices will have their follower stats returned.
 
 [source,js]
 --------------------------------------------------
@@ -54,8 +51,9 @@ GET /<index>/_ccr/stats
 // CONSOLE
 // TEST[s/<index>/follower_index/]
 
-Here, `<index>` is a comma-delimited list of index patterns that will be matched
-against follower indices to retrieve follower stats for.
+==== Path Components
+`index` ::
+  (string) a comma-delimited list of index patterns
 
 ==== Results
 
@@ -181,12 +179,13 @@ Continuing with the fields from `shards`:
 
 ==== Example
 
+This example retrieves follower stats:
+
 [source,js]
 --------------------------------------------------
 GET /_ccr/stats
 --------------------------------------------------
 // CONSOLE
-// TEST
 
 The API returns the following results:
 [source,js]

docs/reference/ccr/apis/follow/post-pause-follow.asciidoc

@@ -41,11 +41,14 @@ POST /<follower_index>/_ccr/pause_follow
 // CONSOLE
 // TEST[s/<follower_index>/follower_index/]
 
-Here, `<follower_index>` is the name of the follower index to pause.
+==== Path Components
+
+`follower_index` (required)::
+  (string) the name of the follower index
 
 ==== Example
 
-The following is an example of using the pause follower API.
+This example pauses a follower index named `follower_index`:
 
 [source,js]
 --------------------------------------------------

docs/reference/ccr/apis/follow/post-resume-follow.asciidoc

@@ -55,21 +55,24 @@ POST /<follower_index>/_ccr/resume_follow
 // TEST[s/<leader_cluster>/leader_cluster/]
 // TEST[s/<leader_index>/leader_index/]
 
-Here, `<follower_index>` is the name of the follower index to resume.
+==== Path Components
+
+`follower_index` (required)::
+  (string) the name of the follower index
 
 ==== Request Body
-`leader_cluster`::
-  (required string) the <<modules-remote-clusters,remote cluster>> containing the leader
+`leader_cluster` (required)::
+  (string) the <<modules-remote-clusters,remote cluster>> containing the leader
   index
 
-`leader_index`::
-  (required string) the name of the index in the leader cluster to follow
+`leader_index` (required)::
+  (string) the name of the index in the leader cluster to follow
 
 include::../follow-request-body.asciidoc[]
 
 ==== Example
 
-The following is an example of using the resume follower API.
+This example resumes a follower index named `follower_index`:
 
 [source,js]
 --------------------------------------------------

docs/reference/ccr/apis/follow/post-unfollow.asciidoc

@@ -48,12 +48,14 @@ POST /<follower_index>/_ccr/unfollow
 // CONSOLE
 // TEST[s/<follower_index>/follower_index/]
 
-Here, `<follower_index>` is the name of the follower index to convert to a
-regular index.
+==== Path Components
+
+`follower_index` (required)::
+  (string) the name of the follower index
 
 ==== Example
 
-The following is an example of using the unfollow API.
+This example converts `follower_index` from a follower index to a regular index:
 
 [source,js]
 --------------------------------------------------

docs/reference/ccr/apis/follow/put-follow.asciidoc

@@ -12,8 +12,7 @@ Creates a follower index.
 
 This API creates a new follower index that is configured to follow the
 referenced leader index. When this API returns, the follower index exists, and
-{ccr} will start replicating operations from the leader index to the follower
-index.
+{ccr} starts replicating operations from the leader index to the follower index.
 
 ==== Request
 
@@ -42,24 +41,24 @@ PUT /<follower_index>/_ccr/follow
 // TEST[s/<leader_cluster>/leader_cluster/]
 // TEST[s/<leader_index>/leader_index/]
 
-Here, `<follower_index>` is the name of the follower index to create,
-`<leader_cluster>` is the name of the
-<<modules-remote-clusters,remote cluster> containing the leader index, and
-`<leader_index>` is the name of the leader index in that remote cluster.
+==== Path Components
+
+`follower_index` (required)::
+  (string) the name of the follower index
 
 ==== Request Body
-`leader_cluster`::
-  (required string) the <<modules-remote-clusters,remote cluster>> containing the leader
+`leader_cluster` (required)::
+  (string) the <<modules-remote-clusters,remote cluster>> containing the leader
   index
 
-`leader_index`::
-  (required string) the name of the index in the leader cluster to follow
+`leader_index` (required)::
+  (string) the name of the index in the leader cluster to follow
 
 include::../follow-request-body.asciidoc[]
 
 ==== Example
 
-The following is an example of using the create follower API.
+This example creates a follower index named `follower_index`:
 
 [source,js]
 --------------------------------------------------