From 757ed473a56ad747bc9e1f0a78ac149f4c473e4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 12 Jul 2021 11:39:01 +0200 Subject: [PATCH 1/3] [DOCS] Clarifies behavior of datafeeds with or without an end time. --- docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc b/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc index 410055181..c22865f61 100644 --- a/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc +++ b/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc @@ -21,8 +21,13 @@ To start retrieving data from {es}, you must start the {dfeed}. When you start it, you can optionally specify start and end times. If you do not specify an end time, the {dfeed} runs continuously. You can start and stop {dfeeds} in {kib} or use the {ref}/ml-start-datafeed.html[start {dfeeds}] and -{ref}/ml-stop-datafeed.html[stop {dfeeds}] APIs. A {dfeed} can be started and -stopped multiple times throughout its lifecycle. +{ref}/ml-stop-datafeed.html[stop {dfeeds}] APIs. {dfeeds-cap} with an end time +close their corresponding jobs when they are stopped. For this reason, when +historical data is analysed, there is no need to stop the datafeed and/or close +the job as they are stopped and closed automatically when the end time is +reached. However, when a {dfeed} whid an end time is stopped, it does not close +the corresponding job automatically. A {dfeed} can be started and stopped +multiple times throughout its lifecycle. [IMPORTANT] -- From 7db7c052866201519cca6ad25de6d014af3d55ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 12 Jul 2021 11:56:06 +0200 Subject: [PATCH 2/3] [DOCS] Changes sentence order. --- .../ml/anomaly-detection/ml-datafeeds.asciidoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc b/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc index c22865f61..850e94563 100644 --- a/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc +++ b/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc @@ -19,15 +19,15 @@ the {ref}/ml-put-datafeed.html[create {dfeeds} API]. To start retrieving data from {es}, you must start the {dfeed}. When you start it, you can optionally specify start and end times. If you do not specify an -end time, the {dfeed} runs continuously. You can start and stop {dfeeds} in +end time, the {dfeed} runs continuously. {dfeeds-cap} with an end time close +their corresponding jobs when they are stopped. For this reason, when historical +data is analysed, there is no need to stop the datafeed and/or close the job as +they are stopped and closed automatically when the end time is reached. However, +when a {dfeed} whid an end time is stopped, it does not close the corresponding +job automatically. You can start and stop {dfeeds} in {kib} or use the {ref}/ml-start-datafeed.html[start {dfeeds}] and -{ref}/ml-stop-datafeed.html[stop {dfeeds}] APIs. {dfeeds-cap} with an end time -close their corresponding jobs when they are stopped. For this reason, when -historical data is analysed, there is no need to stop the datafeed and/or close -the job as they are stopped and closed automatically when the end time is -reached. However, when a {dfeed} whid an end time is stopped, it does not close -the corresponding job automatically. A {dfeed} can be started and stopped -multiple times throughout its lifecycle. +{ref}/ml-stop-datafeed.html[stop {dfeeds}] APIs. A {dfeed} can be started and +stopped multiple times throughout its lifecycle. [IMPORTANT] -- From a792a4e158bdaff5038a9a4eb0575723f17fb7ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 12 Jul 2021 12:06:27 +0200 Subject: [PATCH 3/3] [DOCS] Fixes typo. --- docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc b/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc index 850e94563..7a5e7b7a6 100644 --- a/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc +++ b/docs/en/stack/ml/anomaly-detection/ml-datafeeds.asciidoc @@ -23,9 +23,9 @@ end time, the {dfeed} runs continuously. {dfeeds-cap} with an end time close their corresponding jobs when they are stopped. For this reason, when historical data is analysed, there is no need to stop the datafeed and/or close the job as they are stopped and closed automatically when the end time is reached. However, -when a {dfeed} whid an end time is stopped, it does not close the corresponding -job automatically. You can start and stop {dfeeds} in -{kib} or use the {ref}/ml-start-datafeed.html[start {dfeeds}] and +when a {dfeed} without an end time is stopped, it does not close the +corresponding job automatically. You can start and stop {dfeeds} in {kib} or use +the {ref}/ml-start-datafeed.html[start {dfeeds}] and {ref}/ml-stop-datafeed.html[stop {dfeeds}] APIs. A {dfeed} can be started and stopped multiple times throughout its lifecycle.