Document the Synthetics UI

[colleenmcginnis]

Closes #2401
Closes #2549

A couple weeks ago, @drewpost @paulb-elastic and I met to talk about how to handle the existence of both Uptime and Synthetics (beta) in the 8.7 release. We discussed:

• Splitting Uptime and Synthetics content into separate top-level sections:
  • The Uptime section should only discuss setting up with Heartbeat and creating lightweight monitors (similar to what was available in the 8.1 documentation).
  • The Synthetics section should include setting up with both project monitors and the Synthetics UI and creating both lightweight and browser monitors.
• All screenshots should be updated to reflect changes to the UI.
• All user workflows should be updated to reflect changes to the UI.
• The docs should cover the new Synthetics UI's empty state.
• The migration doc should point to the Synthetics UI instead of the Uptime app.
• Some content will need to be reviewed to determine if it relevant to Uptime, Synthetics, or both including:
  • All pages under Analyze
  • Configure settings
  • Manage data retention
  • Troubleshoot mapping issues

I have two requests for @drewpost @paulb-elastic and @andrewvc before making changes to docs:

• Does this plan still sound good to you?
• If yes, can you please take a look at the preview site (with separate Uptime and Synthetics sections) and let me know if this aligns with what you're thinking? So far all I've done in this PR is prepare the structure and add some placeholders where I know content will need to be updated and/or written.

[github-actions]

A documentation preview will be available soon:

• 📚 HTML diff
• 📘 Fleet and Elastic Agent Guide
• 📙 Observability Guide

[paulb-elastic]

Thanks for putting this together @colleenmcginnis. I really like this new layout. It finally gives a much better separation we were waiting for but couldn’t do because of having to use Uptime Monitor Management during this transition.

[andrewvc]

I concur with @paulb-elastic , this is a breath of fresh air. Looks great.

[mergify]

This pull request is now in conflict. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue-2401 upstream/issue-2401
git merge upstream/main
git push upstream issue-2401

[colleenmcginnis]

@paulb-elastic this PR is ready for review. Any and all feedback is welcome, but here's the specific feedback I need from the Synthetics team to get this foundation of Synthetics UI docs merged (then we can address other open issues in smaller PRs that are easier to review):

• Analyze data from synthetic monitors: Review full page.
  • Preview link: Analyze data from synthetic monitors
  • File in this PR: docs/en/observability/synthetics-analyze.asciidoc
  • Uptime equivalent: Analyze section
• Adjust Synthetics settings: Review full page.
  • Preview link: Adjust Synthetics settings
  • File in this PR: docs/en/observability/synthetics-settings.asciidoc
  • Uptime equivalent: Configure settings
• Work with params and secrets: Confirm the order of precedence for params defined in (1) Synthetics "Settings" page, (2) configuration file, (3) CLI.
  • Preview link: Work with params and secrets
  • File in this PR: docs/en/observability/synthetics-params-secrets.asciidoc
• Synthetics intro: Provide language explaining the state of the relationship between Uptime and Synthetics in 8.7.
  • Preview link: Synthetic monitoring
  • File in this PR: docs/en/observability/synthetics-intro.asciidoc

Feel free to tag in others to review, and let me know if you have questions for me! I'll plan to do a final pass for redirects, grammar, etc after I know the updated content is correct.

[paulb-elastic]

@colleenmcginnis this is great, thanks for the details of the links to the page/preview and existing version, very helpful.

I've looked at docs/en/observability/synthetics-analyze.asciidoc so far and will continue the others tomorrow

[paulb-elastic]

@colleenmcginnis thanks again for putting all this together. I think I have gone through everything you were asking for input on, but lmk if you need anything else from me.

[colleenmcginnis]

Thanks @paulb-elastic! I addressed your comments and left a few additional questions below.

Up next: I'll do a close pass through all content for consistency and spelling/grammar.

[mergify]

This pull request is now in conflict. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue-2401 upstream/issue-2401
git merge upstream/main
git push upstream issue-2401

[paulb-elastic]

I've left a single comment, and am making a further comment below, but none that block this from being a LGTM.

Here's something I saw when reviewing, not part of this PR, but should be updated.

• Relates to https://www.elastic.co/guide/en/observability/current/synthetics-get-started-project.html#_examine_the_journey_files
• When a new folder has been init we separate out the browser and lightweight examples
  • The journeys folder just contains the browser examples
  • The lightweight folder contains an example heartbeat.yml

So the info is mostly correct, just needs rearranging on the page a bit.