Document the Synthetics UI (#2593)

* split uptime and synthetics * update getting started flows * clean up scripting section * update filenames * update references to private locations * clean up * add details to the analyze monitor data page * Add Synthetics settings page (#1) * add info on alerting settings * add info on private locations settings * add info on global parameters, data retention, and api keys * address feedback from @paulb-elastic * address additional feedback * use consistent language * add note about 'run test manually' only being available for public locations * remove journeys from uptime analyze section * add one more redirect (cherry picked from commit 56cfb75)
elastic · Mar 21, 2023 · b91a349 · b91a349
1 parent a6967be
commit b91a349
Show file tree

Hide file tree

Showing 68 changed files with 838 additions and 521 deletions.
diff --git a/docs/en/observability/images/icons/apmTrace.svg b/docs/en/observability/images/icons/apmTrace.svg
diff --git a/docs/en/observability/images/icons/arrowLeft.svg b/docs/en/observability/images/icons/arrowLeft.svg
diff --git a/docs/en/observability/images/icons/arrowRight.svg b/docs/en/observability/images/icons/arrowRight.svg
diff --git a/docs/en/observability/images/icons/beaker.svg b/docs/en/observability/images/icons/beaker.svg
diff --git a/docs/en/observability/images/icons/calendar.svg b/docs/en/observability/images/icons/calendar.svg
diff --git a/docs/en/observability/images/icons/inspect.svg b/docs/en/observability/images/icons/inspect.svg
diff --git a/docs/en/observability/images/icons/minus.svg b/docs/en/observability/images/icons/minus.svg
diff --git a/docs/en/observability/images/icons/pencil.svg b/docs/en/observability/images/icons/pencil.svg
diff --git a/docs/en/observability/images/icons/popout.svg b/docs/en/observability/images/icons/popout.svg
diff --git a/docs/en/observability/images/icons/sortDown.svg b/docs/en/observability/images/icons/sortDown.svg
diff --git a/docs/en/observability/images/icons/sortUp.svg b/docs/en/observability/images/icons/sortUp.svg
diff --git a/docs/en/observability/images/private-locations-monitor-locations.png b/docs/en/observability/images/private-locations-monitor-locations.png
diff --git a/docs/en/observability/images/synthetics-analyze-individual-monitor-details.png b/docs/en/observability/images/synthetics-analyze-individual-monitor-details.png
diff --git a/docs/en/observability/images/synthetics-analyze-individual-monitor-errors.png b/docs/en/observability/images/synthetics-analyze-individual-monitor-errors.png
diff --git a/docs/en/observability/images/synthetics-analyze-individual-monitor-header.png b/docs/en/observability/images/synthetics-analyze-individual-monitor-header.png
diff --git a/docs/en/observability/images/synthetics-analyze-individual-monitor-history.png b/docs/en/observability/images/synthetics-analyze-individual-monitor-history.png
diff --git a/docs/en/observability/images/synthetics-analyze-journeys-over-time.png b/docs/en/observability/images/synthetics-analyze-journeys-over-time.png
diff --git a/docs/en/observability/images/synthetics-analyze-one-run-code-executed.png b/docs/en/observability/images/synthetics-analyze-one-run-code-executed.png
diff --git a/docs/en/observability/images/synthetics-analyze-one-run-compare-steps.png b/docs/en/observability/images/synthetics-analyze-one-run-compare-steps.png
diff --git a/docs/en/observability/images/synthetics-analyze-one-step-metrics.png b/docs/en/observability/images/synthetics-analyze-one-step-metrics.png
diff --git a/docs/en/observability/images/synthetics-analyze-one-step-network.png b/docs/en/observability/images/synthetics-analyze-one-step-network.png
diff --git a/docs/en/observability/images/synthetics-analyze-one-step-object.png b/docs/en/observability/images/synthetics-analyze-one-step-object.png
diff --git a/docs/en/observability/images/synthetics-analyze-one-step-screenshot.png b/docs/en/observability/images/synthetics-analyze-one-step-screenshot.png
diff --git a/docs/en/observability/images/synthetics-analyze-one-step-timing.png b/docs/en/observability/images/synthetics-analyze-one-step-timing.png
diff --git a/docs/en/observability/images/synthetics-get-started-projects.png b/docs/en/observability/images/synthetics-get-started-projects.png
diff --git a/docs/en/observability/images/synthetics-get-started-ui.png b/docs/en/observability/images/synthetics-get-started-ui.png
diff --git a/docs/en/observability/images/synthetics-monitor-management-api-key.png b/docs/en/observability/images/synthetics-monitor-management-api-key.png
diff --git a/docs/en/observability/images/synthetics-monitor-page.png b/docs/en/observability/images/synthetics-monitor-page.png
diff --git a/docs/en/observability/images/synthetics-settings-alerting.png b/docs/en/observability/images/synthetics-settings-alerting.png
diff --git a/docs/en/observability/images/synthetics-settings-api-keys.png b/docs/en/observability/images/synthetics-settings-api-keys.png
diff --git a/docs/en/observability/images/synthetics-settings-data-retention.png b/docs/en/observability/images/synthetics-settings-data-retention.png
diff --git a/docs/en/observability/images/synthetics-settings-global-parameters.png b/docs/en/observability/images/synthetics-settings-global-parameters.png
diff --git a/docs/en/observability/images/synthetics-settings-private-locations.png b/docs/en/observability/images/synthetics-settings-private-locations.png
diff --git a/docs/en/observability/images/synthetics-ui-inline-script.png b/docs/en/observability/images/synthetics-ui-inline-script.png
diff --git a/docs/en/observability/images/uptime-app-inline-script.png b/docs/en/observability/images/uptime-app-inline-script.png
diff --git a/docs/en/observability/images/uptime-set-up-ui.asciidoc.png b/docs/en/observability/images/uptime-set-up-ui.asciidoc.png
diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc
@@ -29,6 +29,10 @@ include::{docs-root}/shared/attributes.asciidoc[]
 :kibana-repo-dir:      {kibana-root}/docs 
 
 :synthetics_version: v1.0.0-beta.40
+:project-monitors: project monitors
+:project-monitors-cap: Project monitors
+:synthetics-app: Synthetics app
+:private-location: Private Location
 
 // What is Observability?
 include::observability-introduction.asciidoc[leveloffset=+1]
@@ -100,14 +104,27 @@ include::inspect-metric-anomalies.asciidoc[leveloffset=+2]
 
 include::configure-metrics-sources.asciidoc[leveloffset=+2]
 
-// Uptime & Synthetic monitoring
-include::monitor-uptime-synthetics.asciidoc[leveloffset=+1]
+// Uptime
+include::uptime-intro.asciidoc[leveloffset=+1]
+
+include::uptime-get-started-heartbeat.asciidoc[leveloffset=+2]
+
+include::uptime-analyze.asciidoc[leveloffset=+2]
+include::uptime-view-monitor-status.asciidoc[leveloffset=+3]
+include::uptime-analyze-monitors.asciidoc[leveloffset=+3]
+include::uptime-inspect-duration-anomalies.asciidoc[leveloffset=+3]
+
+include::configure-uptime-settings.asciidoc[leveloffset=+2]
+
+include::troubleshoot-uptime-mapping-issues.asciidoc[leveloffset=+2]
+
+// Synthetics
+include::synthetics-intro.asciidoc[leveloffset=+1]
 
 :playwright-url:      https://playwright.dev/
 :playwright-api-docs: https://playwright.dev/docs/api/class-playwright
 
 include::synthetics-get-started.asciidoc[leveloffset=+2]
-include::synthetics-get-started-heartbeat.asciidoc[leveloffset=+3]
 include::synthetics-get-started-project.asciidoc[leveloffset=+3]
 include::synthetics-get-started-ui.asciidoc[leveloffset=+3]
 
@@ -121,24 +138,18 @@ include::synthetics-lightweight.asciidoc[leveloffset=+2]
 
 include::synthetics-manage-monitors.asciidoc[leveloffset=+2]
 
-include::uptime-analyze.asciidoc[leveloffset=+2]
-include::view-monitor-status.asciidoc[leveloffset=+3]
-include::synthetics-visualize.asciidoc[leveloffset=+3]
-include::analyze-monitors.asciidoc[leveloffset=+3]
-include::inspect-uptime-duration-anomalies.asciidoc[leveloffset=+3]
+include::synthetics-analyze.asciidoc[leveloffset=+2]
 
 include::synthetics-private-location.asciidoc[leveloffset=+2]
 
 include::synthetics-command-reference.asciidoc[leveloffset=+2]
 
 include::synthetics-configuration.asciidoc[leveloffset=+2]
 
-include::configure-uptime-settings.asciidoc[leveloffset=+2]
+include::synthetics-settings.asciidoc[leveloffset=+2]
 
 include::synthetics-manage-retention.asciidoc[leveloffset=+2]
 
-include::troubleshoot-uptime-mapping-issues.asciidoc[leveloffset=+2]
-
 include::synthetics-migrate-integration.asciidoc[leveloffset=+2]
 
 // User experience

diff --git a/docs/en/observability/redirects.asciidoc b/docs/en/observability/redirects.asciidoc
@@ -42,7 +42,12 @@ Refer to <<synthetics-get-started>>.
 [role="exclude" id="uptime-set-up-choose-heartbeat"]
 === Use lightweight monitors with {heartbeat}
 
-Refer to <<synthetics-get-started-heartbeat>>.
+Refer to <<uptime-get-started>>.
+
+[role="exclude" id="synthetics-get-started-heartbeat"]
+=== Create monitors with {heartbeat}
+
+Refer to <<uptime-get-started>>.
 
 [role="exclude" id="uptime-set-up-choose-agent"]
 === Use lightweight monitors with the {uptime-app}
@@ -59,4 +64,9 @@ Refer to <<synthetics-get-started-project>>.
 
 [[synthetic-monitor-choose-project]]
 
-Refer to <<synthetics-get-started-project>>.
+Refer to <<synthetics-get-started-project>>.
+
+[role="exclude" id="synthetics-visualize"]
+=== Visualize journeys
+
+Refer to <<synthetics-analyze-journeys>>.