[DOCS] Reworks the Examples section in anomaly detection docs (elastic#2181)

szabosteve · elasticmachine · web-flow · commit b6a1f8ccd712 · 2022-09-21T11:07:48.000+02:00
* [DOCS] Reworks the Examples section in anomaly detection docs.

* [DOCS] Changes attribute.

* [DOCS] Adds getting started link to the overview section.

* Renames page to How-to guides.

* Adjusts getting started subpages.

* Renames example file and adds redirect.

* Changes reference name on overview page.

* Removes references from Advanced concepts page.

Co-authored-by: Elastic Machine &lt;elasticmachine@users.noreply.github.com&gt;
diff --git a/docs/en/stack/ml/anomaly-detection/anomaly-how-tos.asciidoc b/docs/en/stack/ml/anomaly-detection/anomaly-how-tos.asciidoc
@@ -1,26 +1,22 @@
-[[anomaly-examples]]
-= {anomaly-detect-cap} examples
+[[anomaly-how-tos]]
+= How-to guides
 ++++
-<titleabbrev>Examples</titleabbrev>
+<titleabbrev>How-tos</titleabbrev>
 ++++
 
 Though it is quite simple to analyze your data and provide quick {ml} results,
 gaining deep insights might require some additional planning and configuration.
-The scenarios in this section describe some best practices for generating useful
+The guides in this section describe some best practices for generating useful
 {ml} results and insights from your data.
 
-* <<ml-getting-started>>
-* <<ml-configuring-alerts>>
-* <<ml-configuring-aggregation>>
+* <<ml-configuring-aggregation, Using aggregations in {dfeeds}>>
+* <<ml-configuring-transform, Using runtime fields in {dfeeds}>>
 * <<ml-configuring-detector-custom-rules>>
-* <<ml-configuring-categories>>
 * <<ml-reverting-model-snapshot>>
 * <<geographic-anomalies>>
+* <<mapping-anomalies>>
 * <<ml-configuring-populations>>
-* <<ml-configuring-transform>>
 * <<ml-configuring-url>>
-* <<ml-delayed-data-detection>>
-* <<mapping-anomalies>>
 * <<ml-jobs-from-lens>>
 * <<move-jobs>>
 
diff --git a/docs/en/stack/ml/anomaly-detection/index.asciidoc b/docs/en/stack/ml/anomaly-detection/index.asciidoc
@@ -10,22 +10,26 @@ include::ml-ad-view-results.asciidoc[leveloffset=+2]
 
 include::ml-ad-forecast.asciidoc[leveloffset=+2]
 
+include::../get-started/index.asciidoc[leveloffset=+1]
+
 include::ml-ad-concepts.asciidoc[leveloffset=+1]
 
 include::ml-ad-algorithms.asciidoc[leveloffset=+2]
 
 include::anomaly-detection-scale.asciidoc[leveloffset=+2]
 
-include::ml-api-quickref.asciidoc[leveloffset=+1]
+include::{es-repo-dir}/ml/anomaly-detection/ml-delayed-data-detection.asciidoc[leveloffset=+2]
 
-include::anomaly-examples.asciidoc[leveloffset=+1]
+include::ml-api-quickref.asciidoc[leveloffset=+1]
 
-include::../get-started/index.asciidoc[leveloffset=+2]
+include::anomaly-how-tos.asciidoc[leveloffset=+1]
 
 include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-alerts.asciidoc[leveloffset=+2]
 
 include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-aggregations.asciidoc[leveloffset=+2]
 
+include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-transform.asciidoc[leveloffset=+2]
+
 include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-detector-custom-rules.asciidoc[leveloffset=+2]
 
 include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-categories.asciidoc[leveloffset=+2]
@@ -34,16 +38,12 @@ include::ml-revert-model-snapshot.asciidoc[leveloffset=+2]
 
 include::geographic-anomalies.asciidoc[leveloffset=+2]
 
-include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-populations.asciidoc[leveloffset=+2]
+include::mapping-anomalies.asciidoc[leveloffset=+2]
 
-include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-transform.asciidoc[leveloffset=+2]
+include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-populations.asciidoc[leveloffset=+2]
 
 include::{es-repo-dir}/ml/anomaly-detection/ml-configuring-url.asciidoc[leveloffset=+2]
 
-include::{es-repo-dir}/ml/anomaly-detection/ml-delayed-data-detection.asciidoc[leveloffset=+2]
-
-include::mapping-anomalies.asciidoc[leveloffset=+2]
-
 include::ml-jobs-from-visuals.asciidoc[leveloffset=+2]
 
 include::../move-jobs.asciidoc[leveloffset=+2]
diff --git a/docs/en/stack/ml/anomaly-detection/ml-ad-concepts.asciidoc b/docs/en/stack/ml/anomaly-detection/ml-ad-concepts.asciidoc
@@ -7,3 +7,4 @@ This section explains the more complex concepts of the Elastic {ml}
 
 * <<ml-ad-algorithms>>
 * <<anomaly-detection-scale>>
+* <<ml-delayed-data-detection, Delayed data>>
diff --git a/docs/en/stack/ml/anomaly-detection/ml-ad-overview.asciidoc b/docs/en/stack/ml/anomaly-detection/ml-ad-overview.asciidoc
@@ -5,7 +5,8 @@
 You can use {stack} {ml-features} to analyze time series data and identify anomalous patterns in your data set.
 
 * <<ml-ad-finding-anomalies>>
+* <<ml-getting-started>>
 * <<ml-ad-concepts>>
 * <<ml-api-quickref>>
-* <<anomaly-examples>>
+* <<anomaly-how-tos>>
 * <<ml-ad-resources>>
diff --git a/docs/en/stack/ml/get-started/ml-gs-forecasts.asciidoc b/docs/en/stack/ml/get-started/ml-gs-forecasts.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[discrete]
 [[sample-data-forecasts]]
 = Create forecasts
 
diff --git a/docs/en/stack/ml/get-started/ml-gs-jobs.asciidoc b/docs/en/stack/ml/get-started/ml-gs-jobs.asciidoc
@@ -1,9 +1,7 @@
 [role="xpack"]
+[discrete]
 [[sample-data-jobs]]
 = Create sample {anomaly-jobs} in {kib}
-++++
-<titleabbrev>Create {anomaly-jobs}</titleabbrev>
-++++
 
 The {kib} sample data sets include some pre-configured {anomaly-jobs} for you to
 play with. You can use either of the following methods to add the jobs:
diff --git a/docs/en/stack/ml/get-started/ml-gs-next.asciidoc b/docs/en/stack/ml/get-started/ml-gs-next.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[discrete]
 [[sample-data-next]]
 = Next steps
 
diff --git a/docs/en/stack/ml/get-started/ml-gs-results.asciidoc b/docs/en/stack/ml/get-started/ml-gs-results.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[discrete]
 [[sample-data-results]]
 = View {anomaly-detect} results
 
diff --git a/docs/en/stack/ml/get-started/ml-gs-visualizer.asciidoc b/docs/en/stack/ml/get-started/ml-gs-visualizer.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[discrete]
 [[sample-data-visualizer]]
 = Explore the data in {kib}
 
diff --git a/docs/en/stack/ml/redirects.asciidoc b/docs/en/stack/ml/redirects.asciidoc
@@ -177,4 +177,9 @@ These {anomaly-jobs} were removed in 8.3.0.
 [role="exclude",id="security-winlogbeat-authentication-jobs"]
 === Security: {winlogbeat} authentication
 
-These {anomaly-jobs} were removed in 8.3.0.
+These {anomaly-jobs} were removed in 8.3.0.
+
+[role="exclude",id="anomaly-examples"]
+=== Examples
+
+This page has moved. See <<anomaly-how-tos>>.

Original file line number	Diff line number	Diff line change
`@@ -7,3 +7,4 @@ This section explains the more complex concepts of the Elastic {ml}`
`7`	`7`
`8`	`8`	`* <<ml-ad-algorithms>>`
`9`	`9`	`* <<anomaly-detection-scale>>`
	`10`	`+* <<ml-delayed-data-detection, Delayed data>>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`[role="xpack"]`
	`2`	`+[discrete]`
`2`	`3`	`[[sample-data-forecasts]]`
`3`	`4`	`= Create forecasts`
`4`	`5`