Browse Source

[DOCS] Modifies schedule now transform API docs (#93519)

István Zoltán Szabó 2 years ago
parent
commit
a6f365c51c

+ 1 - 1
docs/reference/transform/api-quickref.asciidoc

@@ -16,9 +16,9 @@ _transform/
 * <<get-transform-stats,Get {transforms} statistics>>
 * <<preview-transform,Preview {transforms}>>
 * <<reset-transform,Reset {transforms}>>
+* <<schedule-now-transform,Schedule now {transforms}>>
 * <<start-transform,Start {transforms}>>
 * <<stop-transform,Stop {transforms}>>
-* <<schedule-now-transform,Schedule Now {transforms}>>
 * <<update-transform,Update {transforms}>>
 
 For the full list, see <<transform-apis>>.

+ 2 - 2
docs/reference/transform/apis/index.asciidoc

@@ -11,12 +11,12 @@ include::get-transform-stats.asciidoc[leveloffset=+2]
 include::preview-transform.asciidoc[leveloffset=+2]
 //RESET
 include::reset-transform.asciidoc[leveloffset=+2]
+//SCHEDULE NOW
+include::schedule-now-transform.asciidoc[leveloffset=+2]
 //START
 include::start-transform.asciidoc[leveloffset=+2]
 //STOP
 include::stop-transform.asciidoc[leveloffset=+2]
-//SCHEDULE_NOW
-include::schedule-now-transform.asciidoc[leveloffset=+2]
 //UPDATE-UPGRADE
 include::update-transform.asciidoc[leveloffset=+2]
 include::upgrade-transforms.asciidoc[leveloffset=+2]

+ 6 - 6
docs/reference/transform/apis/schedule-now-transform.asciidoc

@@ -1,14 +1,14 @@
 [role="xpack"]
 [testenv="basic"]
 [[schedule-now-transform]]
-= Schedule Now {transform} API
+= Schedule now {transform} API
 
 [subs="attributes"]
 ++++
-<titleabbrev>Shedule Now {transform}</titleabbrev>
+<titleabbrev>Schedule now {transform}</titleabbrev>
 ++++
 
-Schedules now a {transform}.
+Instantly runs a {transform} to process data.
 
 [[schedule-now-transform-request]]
 == {api-request-title}
@@ -24,10 +24,10 @@ in the `transform_admin` built-in role.
 [schedule-now-transform-desc]]
 == {api-description-title}
 
-If you _schedule_now a {transform}, it will process the new data instantly,
+When you run this API, the {transform} processes the new data instantly,
 without waiting for the configured `frequency` interval.
-After _schedule_now API is called, the transform will be processed again at
-`now + frequency` unless _schedule_now API is called again in the meantime.
+Subsequently, the transform will be processed again at
+`now + frequency` unless the API is called again in the meantime.
 
 [[schedule-now-transform-path-parms]]
 == {api-path-parms-title}

+ 1 - 1
docs/reference/transform/apis/transform-apis.asciidoc

@@ -8,8 +8,8 @@
 * <<get-transform-stats>>
 * <<preview-transform>>
 * <<reset-transform>>
+* <<schedule-now-transform>>
 * <<start-transform>>
 * <<stop-transform>>
-* <<schedule-now-transform>>
 * <<update-transform>>
 * <<upgrade-transforms>>