Document the Synthetics UI by colleenmcginnis · Pull Request #2593 · elastic/observability-docs

colleenmcginnis · 2023-02-08T21:14:53Z

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 · 2023-02-08T21:15:06Z

A documentation preview will be available soon:

paulb-elastic · 2023-02-09T11:18:37Z

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 · 2023-02-09T20:53:14Z

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

mergify · 2023-02-09T21:05:57Z

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

docs/en/observability/synthetics-analyze.asciidoc

* add info on alerting settings * add info on private locations settings * add info on global parameters, data retention, and api keys

colleenmcginnis · 2023-02-27T17:45:24Z

@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.

docs/en/observability/synthetics-analyze.asciidoc

paulb-elastic · 2023-02-27T19:12:04Z

@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

docs/en/observability/synthetics-settings.asciidoc

docs/en/observability/synthetics-params-secrets.asciidoc

docs/en/observability/synthetics-intro.asciidoc

paulb-elastic · 2023-03-02T10:31:35Z

@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.

docs/en/observability/synthetics-analyze.asciidoc

docs/en/observability/synthetics-intro.asciidoc

docs/en/observability/uptime-intro.asciidoc

mergify · 2023-03-07T19:22:59Z

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

docs/en/observability/synthetics-analyze.asciidoc

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.

…cations

@paulb-elastic

* 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)

@paulb-elastic

* 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) Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

split uptime and synthetics

3548894

colleenmcginnis added the backport-8.7 Automated backport with mergify label Feb 8, 2023

colleenmcginnis self-assigned this Feb 8, 2023

Colleen McGinnis added 6 commits February 9, 2023 16:00

Merge branch 'main' into issue-2401

fc007e8

update getting started flows

a2bff00

clean up scripting section

6a08e7a

update filenames

76789cc

Merge branch 'main' into issue-2401

6ea4757

update references to private locations

618a986

paulb-elastic mentioned this pull request Feb 13, 2023

[Synthetics] Update references to Uptime from the Synthetics Integration elastic/kibana#150896

Closed

Colleen McGinnis added 2 commits February 22, 2023 09:45

clean up

c33c6a8

add details to the analyze monitor data page

264aaaa

colleenmcginnis commented Feb 24, 2023

View reviewed changes

docs/en/observability/synthetics-analyze.asciidoc Show resolved Hide resolved

Add Synthetics settings page (#1)

a9f9113

* add info on alerting settings * add info on private locations settings * add info on global parameters, data retention, and api keys

colleenmcginnis marked this pull request as ready for review February 27, 2023 17:45

colleenmcginnis requested a review from a team as a code owner February 27, 2023 17:45

colleenmcginnis requested a review from paulb-elastic February 27, 2023 17:45