Skip to content

Commit 1413af4

Browse files
Quick onboarding tweaks (#1274)
* update instructions for clarity * testCommand was missing --------- Co-authored-by: The Typescriptrix <[email protected]>
1 parent f5a1ccd commit 1413af4

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

site/content/docs/playwright-checks/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ What you need:
6363
npm install --save-dev jiti typescript
6464
```
6565

66-
### 3. Test and create a monitor with all your tests
66+
### 3. [If you are new to Checkly] Test and create a monitor with all your tests
6767

6868
From inside your repository's source code directory, run:
6969

@@ -78,7 +78,7 @@ What you need:
7878

7979
Of course, you can now run `npx checkly deploy` and have a big monitor that checks your whole suite.
8080

81-
It's likely only some tagged tests or Playwright projects need to become monitors. You can now update your `checkly.config.ts/js` file to select the tests to become individual monitors, with their own schedule, location and configuration.
81+
It's likely that only some tagged tests or Playwright projects need to become monitors. You can now update your `checkly.config.ts/js` file to select the tests to become individual monitors, with their own schedule, location, and configuration.
8282

8383
Here's a fully working example. Adjust the `pwProjects` and `pwTags` to ones that exist in your code.
8484

site/content/docs/playwright-checks/reference.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ menu:
1414
To define your Playwright Check Suite, you use the `checkly.config.ts/js` file.
1515

1616
Each Playwright Check Suite is connected to an existing reference in your `playwright.config.ts/js` file.
17-
During the Alpha, a Playwright Check Suite can last up to 20 minutes. This limit is open to be increased / decreased after the alpha.
17+
During the Alpha, a Playwright Check Suite can last up to 20 minutes. This limit is open to be increased/decreased after the alpha.
1818

1919
## Playwright Check Suite definition
2020

@@ -53,6 +53,8 @@ These are the available monitoring configuration options:
5353

5454
* `installCommand:` Override the command to install dependencies, by default it'll use `npm install --dev`.
5555

56+
* `testCommand:` Override the command to test, by default it uses npx playwright test with the tags, projects, and config file options your check specifies.
57+
5658
* `activated:` A boolean value to activate/run your check or not.
5759

5860
* `muted:` A boolean value to mute Alert notifications.

0 commit comments

Comments
 (0)