[DOCS-9465] adding Synthetics templates #26462

aliciascott · 2024-11-22T21:26:58Z

What does this PR do? What is the motivation?

Adds documentation on Synthetic Monitoring templates for Browser, API test and mobile app testing

Merge instructions

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

github-actions · 2024-11-22T21:30:43Z

Preview links (active after the `build_preview` check completes)

Modified Files

janine-c

Hey Alicia, just one thing I was wondering about - looks awesome otherwise!

content/en/getting_started/synthetics/browser_test.md

janine-c

Hey Alicia! I made some comments about structure, so we can try and make it as clear as possible when users must perform a step vs. where they decide to do one or more steps instead of others. Don't hesitate to let me know if you have any questions!

content/en/getting_started/synthetics/api_test.md

content/en/getting_started/synthetics/browser_test.md

content/en/synthetics/api_tests/dns_tests.md

content/en/synthetics/api_tests/ssl_tests.md

content/en/synthetics/api_tests/tcp_tests.md

content/en/synthetics/browser_tests/_index.md

content/en/synthetics/mobile_app_testing/_index.md

aliciascott · 2024-12-16T17:23:56Z

Hi @janine-c this is ready for a full review! Thank you for the great feedback :)
Note: The mobile app testing video is a place holder at this time as we're still waiting for a fix to roll out.
Everything else should be good to go!

janine-c

Looks great, Alicia! I know it looks like I made a ton of comments, but it's really just the same couple of points over and over that I wanted to help you spot (if you do decide to address them) because there's so much content and it's easy to miss things when the feedback is repetitive.

A couple of other minor things I spotted throughout that are low-stakes and that you don't have to deal with now:

I noticed some inconsistent spacing when referring to buttons that started with a + - for example, +Add thing vs. + Add thing. I like the space because it's easier to read and mimics the UI better, but it's not the end of the world if it stays in there.
When a step is optional, I like to indicate that at the beginning of the step - it makes it a lot easier for a user to scan through and quickly decide whether they need to read that step (for example, if they want to just set something up quickly to get themselves unblocked) or if they can skip it. It can add some cognitive load to read through something just to realize that it wasn't necessary in the first place! But I get that this wasn't introduced with this PR, so no worries if you don't get to this right now.

content/en/getting_started/synthetics/api_test.md

content/en/getting_started/synthetics/browser_test.md

content/en/synthetics/browser_tests/_index.md

content/en/synthetics/mobile_app_testing/_index.md

…ideo

rtrieu

A few minor suggestions (some for a future iteration), but not blocking. Great update!

rtrieu · 2024-12-23T20:44:39Z

content/en/getting_started/synthetics/api_test.md

-    - You can set tags such as `env:prod` and `app:shopist` on your test. Tags allow you to keep your test suite organized and quickly find tests you're interested in on the homepage.
+3. You may create a test using one of the following options:
+
+   - **Create a test from a template**:


Not a huge deal, but I would consider making these options their own H3 sections in the next iteration.

yeah good callout! We went back and forth on this and landed with this layout for now, but I can improve on this down the road :)

content/en/synthetics/api_tests/dns_tests.md

rtrieu · 2024-12-23T21:58:56Z

content/en/getting_started/synthetics/browser_test.md

-      In this example, no specific advanced option is needed.
-    - Name your test and set tags to it such as `env:prod` and `app:shopist`. Tags allow you to keep your test suite organized and quickly find tests you're interested in on the homepage.
-    - Choose the browsers and devices you want to test with. 
+You may create a test using one of the following options:


Suggested change

You may create a test using one of the following options:

You can create a test from a template or from scratch.

For next time!

rtrieu · 2024-12-23T22:00:14Z

content/en/getting_started/synthetics/browser_test.md

-    - Choose the browsers and devices you want to test with. 
+You may create a test using one of the following options:
+
+- **Create a test from a template**:


Suggested change

- **Create a test from a template**:

#### Create a test from a template

For next time!

Co-authored-by: Rosa Trieu <[email protected]>

aliciascott · 2024-12-23T22:31:17Z

/merge

dd-devflow · 2024-12-23T22:31:25Z

Devflow running: `/merge`

View all feedbacks in Devflow UI.

2024-12-23 22:31:24 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2024-12-23 22:45:39 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in master is 7m.

2024-12-23 22:51:20 UTC ℹ️ MergeQueue: This merge request was merged

adding Synthetics templates

d02d928

aliciascott requested a review from a team as a code owner November 22, 2024 21:26

aliciascott added the WORK IN PROGRESS No review needed, it's a wip ;) label Nov 22, 2024

github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Nov 22, 2024

removing mobile app testing

8157148

janine-c reviewed Nov 26, 2024

View reviewed changes

content/en/getting_started/synthetics/browser_test.md Outdated Show resolved Hide resolved

aliciascott and others added 2 commits December 11, 2024 14:03

Merge branch 'master' into aliciascott/DOCS-9465-E2E-tests

897f39c

updates to Synthetics templates

83fd639

aliciascott requested a review from janine-c December 11, 2024 21:41

janine-c reviewed Dec 11, 2024

View reviewed changes

aliciascott added 6 commits December 12, 2024 09:05

adding steps for api tests getting started

449c451

formatting

a6148a7

wording

787cad8

formatting

d269d7c

restructuring layout

92ad046

dns/http/ssl/api

eec9d25

aliciascott requested a review from a team as a code owner December 13, 2024 05:18

aliciascott added 2 commits December 12, 2024 22:21

resetting go files

628ba33

uploading video and all API Tests configs

291813c

github-actions bot removed the Architecture Everything related to the Doc backend label Dec 13, 2024

aliciascott added 3 commits December 15, 2024 21:35

finalizing API tests based on review

ecf4045

updating Browser tests

b65d6e2

adding mobile app tests

3fd5b53

updating Browser

b417bdd

janine-c reviewed Dec 19, 2024

View reviewed changes

updates to Templates PR from editorial review and adding mobile app v…

96457f4

…ideo

rtrieu approved these changes Dec 23, 2024

View reviewed changes

Apply suggestions from code review

a1c6396

Co-authored-by: Rosa Trieu <[email protected]>

dd-devflow bot added mergequeue-status: waiting mergequeue-status: queued mergequeue-status: in_progress and removed mergequeue-status: waiting mergequeue-status: queued labels Dec 23, 2024

dd-mergequeue bot merged commit cfd1f41 into master Dec 23, 2024
16 of 19 checks passed

dd-devflow bot removed the mergequeue-status: in_progress label Dec 23, 2024

dd-mergequeue bot deleted the aliciascott/DOCS-9465-E2E-tests branch December 23, 2024 22:51

dd-devflow bot added the mergequeue-status: done label Dec 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS-9465] adding Synthetics templates #26462

[DOCS-9465] adding Synthetics templates #26462

aliciascott commented Nov 22, 2024

github-actions bot commented Nov 22, 2024

janine-c left a comment

janine-c left a comment

aliciascott commented Dec 16, 2024 •

edited

Loading

janine-c left a comment

rtrieu left a comment

rtrieu Dec 23, 2024

aliciascott Dec 23, 2024

rtrieu Dec 23, 2024

rtrieu Dec 23, 2024

aliciascott commented Dec 23, 2024

dd-devflow bot commented Dec 23, 2024 •

edited

Loading

	You may create a test using one of the following options:
	You can create a test from a template or from scratch.

	- Create a test from a template:
	#### Create a test from a template

[DOCS-9465] adding Synthetics templates #26462

[DOCS-9465] adding Synthetics templates #26462

Conversation

aliciascott commented Nov 22, 2024

What does this PR do? What is the motivation?

Merge instructions

Additional notes

github-actions bot commented Nov 22, 2024

Preview links (active after the build_preview check completes)

Modified Files

janine-c left a comment

Choose a reason for hiding this comment

janine-c left a comment

Choose a reason for hiding this comment

aliciascott commented Dec 16, 2024 • edited Loading

janine-c left a comment

Choose a reason for hiding this comment

rtrieu left a comment

Choose a reason for hiding this comment

rtrieu Dec 23, 2024

Choose a reason for hiding this comment

aliciascott Dec 23, 2024

Choose a reason for hiding this comment

rtrieu Dec 23, 2024

Choose a reason for hiding this comment

rtrieu Dec 23, 2024

Choose a reason for hiding this comment

aliciascott commented Dec 23, 2024

dd-devflow bot commented Dec 23, 2024 • edited Loading

Devflow running: /merge

Preview links (active after the `build_preview` check completes)

aliciascott commented Dec 16, 2024 •

edited

Loading

dd-devflow bot commented Dec 23, 2024 •

edited

Loading

Devflow running: `/merge`