Skip to content

Commit 40d0bae

Browse files
committed
fix: update reference docs in checkly.rules.md
1 parent 94c7bfb commit 40d0bae

File tree

1 file changed

+27
-21
lines changed

1 file changed

+27
-21
lines changed

packages/cli/src/rules/checkly.rules.template.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
- Refer to docs for Checkly CLI v6.0.0 and above.
44
- Check the Checkly CLI output to figure out into which folder the setup was generated.
5-
- Use the [Checkly CLI reference documentation](https://www.checklyhq.com/docs/cli/command-line-reference).
6-
- Use the [Checkly construct reference documentation](https://www.checklyhq.com/docs/cli/constructs-reference).
7-
- Import and / or require any constructs you need in your code, such as `ApiCheck`, `BrowserCheck` from the `checkly/constructs` package.
5+
- Use the [Checkly CLI reference documentation](https://www.checklyhq.com/docs/cli/overview/).
6+
- Use the [Checkly construct reference documentation](https://www.checklyhq.com/docs/constructs/overview/).
7+
- Import and / or require any constructs you need in your code, such as `ApiCheck`, `BrowserCheck`, or `PlaywrightCheck` from the `checkly/constructs` package.
88
- Always ground generated code and CLI commands against the official documentation and examples in this file.
99

1010
## Installing the Checkly CLI
@@ -38,8 +38,8 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
3838
### API Check
3939

4040
- Import the `ApiCheck` construct from `checkly/constructs`.
41-
- Reference [the docs for API checks](https://www.checklyhq.com/docs/cli/constructs-reference/#apicheck) before generating any code.
42-
- When adding `assertions`, always use `AssertionBuilder` class for API Checks which are [documented here](https://www.checklyhq.com/docs/cli/constructs-reference/#assertionbuilder).
41+
- Reference [the docs for API checks](https://www.checklyhq.com/docs/constructs/api-check/) before generating any code.
42+
- When adding `assertions`, always use `AssertionBuilder` class for API Checks.
4343
- When referencing environment variables always use the handlebar syntax `{{MY_ENV_VAR}}`.
4444
- When referencing secrets always use the handlebar syntax `{{MY_SECRET}}`.
4545
- If endpoints require authentication ask the user which authentication method to use and then generate a setupScript to authenticate the given requests.
@@ -60,7 +60,7 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
6060
### Browser Check
6161

6262
- Import the `BrowserCheck` construct from `checkly/constructs`.
63-
- Reference [the docs for Browser checks](https://www.checklyhq.com/docs/cli/constructs-reference/#browsercheck) before generating any code.
63+
- Reference [the docs for Browser checks](https://www.checklyhq.com/docs/constructs/browser-check/) before generating any code.
6464
- Generate a separate `.spec.ts` file for the Playwright code referenced in the `BrowserCheck` construct.
6565
- Use the `code.entrypoint` property to specify the path to your Playwright test file.
6666

@@ -71,7 +71,7 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
7171
### MultiStep Check
7272

7373
- Import the `MultiStepCheck` construct from `checkly/constructs`.
74-
- Reference [the docs for Multistep checks](https://www.checklyhq.com/docs/cli/constructs-reference/#multistepcheck) before generating any code.
74+
- Reference [the docs for Multistep checks](https://www.checklyhq.com/docs/constructs/multistep-check/) before generating any code.
7575
- Generate a separate `.spec.ts` file for the Playwright code referenced in the `MultiStepCheck` construct.
7676
- Use the `code.entrypoint` property to specify the path to your Playwright test file.
7777

@@ -82,8 +82,8 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
8282
### TCP Monitor
8383

8484
- Import the `TcpMonitor` construct from `checkly/constructs`.
85-
- Reference [the docs for TCP monitors](https://www.checklyhq.com/docs/cli/constructs-reference/#tcpmonitor) before generating any code.
86-
- When adding `assertions`, always use `TcpAssertionBuilder` class for TCP monitors which is [documented here](https://www.checklyhq.com/docs/cli/constructs-reference/#tcpassertionbuilder)
85+
- Reference [the docs for TCP monitors](https://www.checklyhq.com/docs/constructs/tcp-monitor/) before generating any code.
86+
- When adding `assertions`, always use `TcpAssertionBuilder` class for TCP monitors.
8787

8888
```typescript
8989
// INSERT TCP MONITOR EXAMPLE HERE //
@@ -92,8 +92,8 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
9292
### URL Monitor
9393

9494
- Import the `UrlMonitor` construct from `checkly/constructs`.
95-
- Reference [the docs for URL monitors](https://www.checklyhq.com/docs/cli/constructs-reference/#urlmonitor) before generating any code.
96-
- When adding `assertions`, always use `UrlAssertionBuilder` class which is [documented here](https://www.checklyhq.com/docs/cli/constructs-reference/#urlassertionbuilder)
95+
- Reference [the docs for URL monitors](https://www.checklyhq.com/docs/constructs/url-monitor/) before generating any code.
96+
- When adding `assertions`, always use `UrlAssertionBuilder`.
9797

9898
```typescript
9999
// INSERT URL MONITOR EXAMPLE HERE //
@@ -102,8 +102,8 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
102102
### DNS Monitor
103103

104104
- Import the `DnsMonitor` construct from `checkly/constructs`.
105-
- Reference [the docs for DNS monitors](https://www.checklyhq.com/docs/cli/constructs-reference/#dnsmonitor) before generating any code.
106-
- When adding `assertions`, always use `DnsAssertionBuilder` class which is [documented here](https://www.checklyhq.com/docs/cli/constructs-reference/#dnsassertionbuilder)
105+
- Reference [the docs for DNS monitors](https://www.checklyhq.com/docs/constructs/dns-monitor/) before generating any code.
106+
- When adding `assertions`, always use `DnsAssertionBuilder` class.
107107

108108
```typescript
109109
// INSERT DNS MONITOR EXAMPLE HERE //
@@ -112,7 +112,7 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
112112
### Heartbeat Monitor
113113

114114
- Import the `HeartbeatMonitor` construct from `checkly/constructs`.
115-
- Reference [the docs for Heartbeat monitor](https://www.checklyhq.com/docs/cli/constructs-reference/#heartbeatmonitor) before generating any code.
115+
- Reference [the docs for Heartbeat monitor](https://www.checklyhq.com/docs/constructs/heartbeat-monitor/) before generating any code.
116116

117117
```typescript
118118
// INSERT HEARTBEAT MONITOR EXAMPLE HERE //
@@ -121,7 +121,7 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
121121
### Check Group
122122

123123
- Import the `CheckGroupV2` construct from `checkly/constructs`.
124-
- Reference [the docs for Check Groups](https://www.checklyhq.com/docs/cli/constructs-reference/#checkgroupv2) before generating any code.
124+
- Reference [the docs for Check Groups](https://www.checklyhq.com/docs/constructs/check-group-v2/) before generating any code.
125125
- Check Groups are used to group checks together for easier management and organization.
126126
- Checks are added to Check Groups by referencing the group in the `group` property of a check.
127127

@@ -134,24 +134,30 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
134134
- Alert channels are used to send notifications when checks and monitors fail or recover.
135135
- Alert channels are added to checks, monitors, and check groups constructs by adding them to the `alertChannels` array property.
136136

137-
Here are some examples of how to create different types of alert channels. All alert are described in the [Checkly docs](https://www.checklyhq.com/docs/cli/constructs-reference/#alertchannel).
137+
Here are some examples of how to create different types of alert channels. All alert are described in the [Checkly docs](https://www.checklyhq.com/docs/constructs/overview/).
138138

139139
### Email Alert Channel
140140

141+
- Reference [the docs for Email Alert Channels](https://www.checklyhq.com/docs/constructs/email-alert-channel/) before generating any code.
142+
141143
```typescript
142144
// INSERT EMAIL ALERT CHANNEL EXAMPLE HERE //
143145
```
144146

145147

146148
### Phone Call Alert Channel
147149

150+
- Reference [the docs for Phone Call Alert Channels](https://www.checklyhq.com/docs/constructs/phone-call-alert-channel/) before generating any code.
151+
148152
```typescript
149153
// INSERT PHONE CALL ALERT CHANNEL EXAMPLE HERE //
150154
```
151155

152156

153157
### Slack Alert Channel
154158

159+
- Reference [the docs for Slack Alert Channels](https://www.checklyhq.com/docs/constructs/slack-alert-channel/) before generating any code.
160+
155161
```typescript
156162
// INSERT SLACK ALERT CHANNEL EXAMPLE HERE //
157163
```
@@ -162,7 +168,7 @@ Here are some examples of how to create different types of alert channels. All a
162168
### Status Page
163169

164170
- Import the `StatusPage` construct from `checkly/constructs`.
165-
- Reference [the docs for StatusPages](https://www.checklyhq.com/docs/cli/constructs-reference/#statuspage) before generating any code.
171+
- Reference [the docs for StatusPages](https://www.checklyhq.com/docs/constructs/status-page/) before generating any code.
166172
- Status pages are used to display the status of your services to your users.
167173
- A Status Page consists of cards which include Status Page Services.
168174

@@ -173,7 +179,7 @@ Here are some examples of how to create different types of alert channels. All a
173179
### Status Page Service
174180

175181
- Import the `StatusPageService` construct from `checkly/constructs`.
176-
- Reference [the docs for Status Page Services](https://www.checklyhq.com/docs/cli/constructs-reference/#statuspageservice) before generating any code.
182+
- Reference [the docs for Status Page Services](https://www.checklyhq.com/docs/constructs/status-page-service/) before generating any code.
177183
- Status Page Services are used to represent individual services on a Status Page.
178184

179185
```typescript
@@ -183,7 +189,7 @@ Here are some examples of how to create different types of alert channels. All a
183189
### Dashboard
184190

185191
- Import the `Dashboard` construct from `checkly/constructs`.
186-
- Reference [the docs for Dashboards](https://www.checklyhq.com/docs/cli/constructs-reference/#dashboard) before generating any code.
192+
- Reference [the docs for Dashboards](https://www.checklyhq.com/docs/constructs/dashboard/) before generating any code.
187193
- Dashboards are used to display the results of your checks on screens external to Checkly.
188194

189195
```typescript
@@ -193,7 +199,7 @@ Here are some examples of how to create different types of alert channels. All a
193199
### Maintenance Window
194200

195201
- Import the `MaintenanceWindow` construct from `checkly/constructs`.
196-
- Reference [the docs for Maintenance Windows](https://www.checklyhq.com/docs/cli/constructs-reference/#maintenancewindow) before generating any code.
202+
- Reference [the docs for Maintenance Windows](https://www.checklyhq.com/docs/constructs/maintenance-window/) before generating any code.
197203
- Maintenance windows are used to pause checks during maintenance periods so no alerts are sent.
198204
- Checks are referenced by their tags in the `tags` property.
199205

@@ -204,7 +210,7 @@ Here are some examples of how to create different types of alert channels. All a
204210
### Private Location
205211

206212
- Import the `PrivateLocation` construct from `checkly/constructs`.
207-
- Reference [the docs for Private Locations](https://www.checklyhq.com/docs/cli/constructs-reference/#privatelocation) before generating any code.
213+
- Reference [the docs for Private Locations](https://www.checklyhq.com/docs/constructs/private-location/) before generating any code.
208214
- Private locations are used to run checks from your own infrastructure with the Checkly Agent, an OCI compatible container.
209215

210216
```typescript

0 commit comments

Comments
 (0)