Address PR feedback

Also move the experimental marker to similar position (before description) on existing endpoint docs for UA.
elastic · Mar 12, 2020 · 20220aa · 20220aa
1 parent 0747a70
commit 20220aa
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/docs/api/upgrade-assistant/batch_queue.asciidoc b/docs/api/upgrade-assistant/batch_queue.asciidoc
@@ -4,10 +4,10 @@
 <titleabbrev>Batch reindex queue</titleabbrev>
 ++++
 
-Check the current reindex batch queue.
-
 experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
 
+Check the current reindex batch queue.
+
 [[batch-reindex-queue-request]]
 ==== Request
 
@@ -64,5 +64,5 @@ The API returns the following:
 }
 --------------------------------------------------
 
-<1> Items in this array indicate reindex tasks at a given point in time
+<1> Items in this array indicate reindex tasks at a given point in time and the order in which they will be executed.
 
diff --git a/docs/api/upgrade-assistant/batch_reindexing.asciidoc b/docs/api/upgrade-assistant/batch_reindexing.asciidoc
@@ -4,12 +4,12 @@
 <titleabbrev>Batch start or resume reindex</titleabbrev>
 ++++
 
-Enables starting or resuming multiple reindexing tasks in one request. Additionally, reindexing tasks started or resumed
-via the batch endpoint will be placed on a queue and executed one-by-one which ensures that minimal cluster resources
-are consumed over time.
-
 experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
 
+Start or resume multiple reindexing tasks in one request. Additionally, reindexing tasks started or resumed
+via the batch endpoint will be placed on a queue and executed one-by-one, which ensures that minimal cluster resources
+are consumed over time.
+
 [[batch-start-resume-reindex-request]]
 ==== Request
 
@@ -42,7 +42,7 @@ POST /api/upgrade_assistant/reindex/batch
 --------------------------------------------------
 <1> The order in which the indices are provided here determines the order in which the reindex tasks will be executed.
 
-The API returns the following which is similar to the <<start-resume-reindex, start or resume endpoint>>:
+Similar to the <<start-resume-reindex, start or resume endpoint>>, the API returns the following:
 
 [source,js]
 --------------------------------------------------

diff --git a/docs/api/upgrade-assistant/cancel_reindex.asciidoc b/docs/api/upgrade-assistant/cancel_reindex.asciidoc
@@ -4,10 +4,10 @@
 <titleabbrev>Cancel reindex</titleabbrev>
 ++++
 
-Cancel reindexes that are waiting for the Elasticsearch reindex task to complete. For example, `lastCompletedStep` set to `40`.
-
 experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
 
+Cancel reindexes that are waiting for the Elasticsearch reindex task to complete. For example, `lastCompletedStep` set to `40`.
+
 [[cancel-reindex-request]]
 ==== Request
 

diff --git a/docs/api/upgrade-assistant/check_reindex_status.asciidoc b/docs/api/upgrade-assistant/check_reindex_status.asciidoc
@@ -4,10 +4,10 @@
 <titleabbrev>Check reindex status</titleabbrev>
 ++++
 
-Check the status of the reindex operation.
-
 experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
 
+Check the status of the reindex operation.
+
 [[check-reindex-status-request]]
 ==== Request
 

diff --git a/docs/api/upgrade-assistant/reindexing.asciidoc b/docs/api/upgrade-assistant/reindexing.asciidoc
@@ -4,10 +4,10 @@
 <titleabbrev>Start or resume reindex</titleabbrev>
 ++++
 
-Start a new reindex or resume a paused reindex.
-
 experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
 
+Start a new reindex or resume a paused reindex.
+
 [[start-resume-reindex-request]]
 ==== Request
 

diff --git a/docs/api/upgrade-assistant/status.asciidoc b/docs/api/upgrade-assistant/status.asciidoc
@@ -4,10 +4,10 @@
 <titleabbrev>Upgrade readiness status</titleabbrev>
 ++++
 
-Check the status of your cluster.
-
 experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
 
+Check the status of your cluster.
+
 [[upgrade-assistant-api-status-request]]
 ==== Request