Skip to content

Commit 85e7cd9

Browse files
authored
Merge pull request #82 from checkly/minor-docs-improvements
Clean up beta notes and add link
2 parents c63cc1d + 90dba68 commit 85e7cd9

6 files changed

Lines changed: 11 additions & 19 deletions

File tree

detect/synthetic-monitoring/browser-checks/playwright-support.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -158,18 +158,16 @@ To see one way this can look like, see our [example repository](https://github.c
158158

159159
## Global configuration
160160

161-
We are gradually rolling out support for global configuration options for the Playwright Test Runner. This allows you to
161+
We are gradually rolling out support for global configuration options for the Playwright Test Runner. This allows you to
162162
configure your Playwright tests in a single place, instead of having to repeat the same configuration for each test file.
163163

164-
<Warning> This feature is in **beta** and is only available when using the Checkly CLI to manage your checks and associated `.spec.ts|js` files.</Warning>
165-
166164
There are three things you should be aware of:
167165
1. You can only use a subset of the Playwright config options. See the [supported configuration options](#supported-configuration-options) section for more information.
168166
2. You need to add the `playwrightConfig` section to your `checkly.config.ts` file, nested under the `browserChecks` section.
169167
3. We explicitly do not read from the existing `playwright.config.ts` or `playwright.config.js` file in your project. This is to avoid any confusion about which config file is used to run your tests and to prevent any unexpected behaviour.
170168

171169

172-
If you have an existing `playwright.config.ts` or `playwright.config.js` file in your project that you want to import,
170+
If you have an existing `playwright.config.ts` or `playwright.config.js` file in your project that you want to import,
173171
you can simply run the [sync-playwright](/cli/checkly-sync-playwright)
174172

175173
```bash
@@ -389,7 +387,7 @@ await expect(page).toHaveScreenshot('homepage.png')
389387
test('Mobile checkout workflow', async ({ page }) => {
390388
// Simulate iPhone 12
391389
await page.setViewportSize({ width: 390, height: 844 })
392-
390+
393391
// Test mobile-specific interactions
394392
await page.goto('https://shop.example.com')
395393
await page.click('[data-testid="mobile-menu-toggle"]')
@@ -417,7 +415,7 @@ test('Setup authentication', async ({ page }) => {
417415
await page.fill('[name="email"]', process.env.TEST_EMAIL)
418416
await page.fill('[name="password"]', process.env.TEST_PASSWORD)
419417
await page.click('[type="submit"]')
420-
418+
421419
// Save authentication state
422420
await page.context().storageState({ path: 'auth-state.json' })
423421
})
@@ -429,4 +427,4 @@ test('Authenticated user workflow', async ({ page }) => {
429427
await page.goto('https://app.example.com/dashboard')
430428
await expect(page.locator('.welcome-message')).toBeVisible()
431429
})
432-
```
430+
```

detect/synthetic-monitoring/browser-checks/snippets.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ Snippets can be useful for:
1111
- a common navigation flow
1212
- a common setup or teardown procedure
1313

14-
15-
> [!CLI]
16-
> If you are using the CLI, you don't need to use snippets. You can just use `import` or `require` to add any local dependencies from your repo.
17-
> Check the docs on using local dependencies [right here](/cli/npm-packages/).
14+
<Note>
15+
If you are using [the Checkly CLI](/cli/overview), you don't need to use snippets. Use `import` or `require` to add any local dependencies from your repo. Check the docs on [using local dependencies](/platform/runtimes/dependencies#local-dependencies) to learn more.
16+
</Note>
1817

1918
## How to use snippets
2019

detect/synthetic-monitoring/playwright-checks/overview.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,6 @@ Receive notifications when tests fail or performance degrades, keeping your team
5252
</Step>
5353
</Steps>
5454

55-
<Info>
56-
**Runtime Limits**: During Beta, Playwright Checks can run up to 20 minutes per execution. This limit can be adjusted based on feedback.
57-
</Info>
58-
5955
## Test Selection
6056

6157
Your Playwright end-to-end test suite consists of projects, `spec.ts` files and individual tests. Use Playwright Check Suites to select and regroup the tests you want to run as synthetic monitors.

detect/synthetic-monitoring/playwright-checks/test-organization.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Playwright tests are run to validate a pre-production environment and prepare a
3535

3636
Split your Playwright tests into focus areas or groups of urgency to ensure the best monitoring frequency and alerting mechanisms.
3737

38-
The acceptable test duration depends on your application and how quickly you want to be alerted in case of an issue. **If your service level agreements (SLAs) require a fast reaction time, we recommend keeping your Playwright Check Suite execution times as short as possible**.
38+
The acceptable test duration depends on your application and how quickly you want to be alerted in case of an issue. **If [your service level agreements (SLAs)](/learn/incidents/slo-sla-sli) require a fast reaction time, we recommend keeping your Playwright Check Suite execution times as short as possible**.
3939

4040
<Tip>
4141
Remember: 99.9% uptime means about 1 minute and 26 seconds of downtime each day. To ensure high uptime, your Playwright Check Suites should run much faster than the maximum downtime per day. To guarantee a high level of uptime, your Playwright Check Suites should run significantly faster than 1 minute and 26 seconds.

docs.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,6 @@
303303
"resolve/traces/import/overview",
304304
"resolve/traces/import/open-telemetry",
305305
"resolve/traces/import/missing-spans",
306-
307306
"resolve/traces/import/https-grpc"
308307
]
309308
},

resolve/traces/import/open-telemetry.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
title: 'Setting Up The OpenTelemetry Collector'
33
description: 'Learn how to import traces from OpenTelemetry'
44
sidebarTitle: 'From OpenTelemetry'
@@ -53,7 +53,7 @@ service:
5353
```
5454
## Step 2: Restart your collector
5555
56-
Grab your **OTel API key** in the *Send traces* section of the [Open Telemetry Integration page in the Checkly app](https://app.checklyhq.com/settings/account/open-telemetry).
56+
Grab your **OTel API key** in the *Send traces* section of the [Open Telemetry Integration page in the Checkly app](https://app.checklyhq.com/settings/account/open-telemetry).
5757
Now, export your API key in your shell by setting the `CHECKLY_OTEL_API_KEY` environment variable.
5858

5959
```bash Terminal

0 commit comments

Comments
 (0)