Miscellaneous small improvements: typos, updates, etc (#1312)

guolau · web-flow · commit 0cf1bc738e2b · 2025-06-25T15:54:27.000-04:00
* feat: clarify Authorization header format for Jira webhook

* feat: document --debug-bundle option for npx checkly deploy

* feat: add units of measurement to data retention table

* fix: extra space typo on runtime specifications page

* fix: SSLHopper name typo

* feat: update reset password instructions to match the current UI

* feat: clarify that you can set RetryStrategy at the project level as well

* feat: add notification log limitation about SSL cert expiration alerts not being logged

* feat: update runtimeId in code samples to latest runtime

* feat: add Israel to supported countries/regions for phone calls
diff --git a/site/content/docs/accounts-and-users/changing-your-email-password.md b/site/content/docs/accounts-and-users/changing-your-email-password.md
@@ -35,7 +35,8 @@ To change your password, follow these steps:
 
 1. Log out of your current session.
 2. Go to the [login page](https://app.checklyhq.com/login).
-3. Click the **Don't remember your password?** link.
-4. Follow the instructions to reset your password.
+3. Enter your email address and click the **Log in** button.
+4. Click the **Forgot password?** link.
+5. Follow the instructions to reset your password.
 
 After successfully resetting your password, you can log in with your new password.
diff --git a/site/content/docs/alerting-and-retries/alert-notification-log.md b/site/content/docs/alerting-and-retries/alert-notification-log.md
@@ -30,10 +30,11 @@ sent etc.
 
 ## Known limitations
 
-There are some limits to what notification deliveries we can track currently.
+There are some limits to how we track notifications currently.
 
 1. SMS delivery can not be tracked up to your phone correctly receiving the SMS. We currently only track if our SMS 
 provider ([AWS SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-mobile-phone-number-as-subscriber.html)) has correctly 
 received our request to send the SMS.
 2. Email delivery is tracked up to our request to our email provider. We use [Postmark](https://postmarkapp.com/) to send our emails.
 3. Many alert channels are retried transparently: we only show you the result of the last retry.
+4. SSL certificate expiration alerts are not shown in the notification log.
diff --git a/site/content/docs/alerting-and-retries/phone-calls.md b/site/content/docs/alerting-and-retries/phone-calls.md
@@ -29,6 +29,7 @@ You can add as many phone number channels as you like.
 | France (+33)                |
 | Germany (+49)               |
 | India (+91)                 |
+| Israel (+972)               |
 | Lithuania (+370)            |
 | Malta (+356)                |
 | Netherlands (+31)           |
diff --git a/site/content/docs/alerting-and-retries/ssl-expiration.md b/site/content/docs/alerting-and-retries/ssl-expiration.md
@@ -37,7 +37,7 @@ When you update your check's URL or your SSL cert, allow up to an hour for the S
 If prompted with this error, the usual cause is the certificate chain of the given website being incomplete. This will
 not happen with a browser check, because the browser will complete the certificate chain on its own. When running an API check,
 though, no browser is involved - therefore the error takes place. You can use an online SSL checker
-(e.g.: [SSLHopper](https://www.sslshopper.com/ssl-checker.html)) to help you diagnose issues with your certificate.
+(e.g.: [SSL Shopper](https://www.sslshopper.com/ssl-checker.html)) to help you diagnose issues with your certificate.
 
 ## Browser checks
 Since browser checks can connect to multiple domains, you need to set the SSL certificate domain to receive certificate alerts for them. 
diff --git a/site/content/docs/alerting-and-retries/webhooks.md b/site/content/docs/alerting-and-retries/webhooks.md
@@ -353,11 +353,13 @@ We will be creating a POST request to `{{JIRA_INSTANCE_URL}}/rest/api/3/issue`,
 The required headers will be:
 
 ```
-Authorization: <YOUR_JIRA_BASIC_AUTH>
+Authorization: Basic <base64 encoded user_email:api_token_string>
 Accept: application/json
 Content-Type: application/json
 ```
 
+For more details on authenticating with the Jira API, refer to [Atlassian's guide on basic authentication](https://developer.atlassian.com/cloud/jira/software/basic-auth-for-rest-apis/).
+
 An example body could look as follows:
 
 ``` {title="Webhook Body"}
diff --git a/site/content/docs/cli/command-line-reference.md b/site/content/docs/cli/command-line-reference.md
@@ -83,6 +83,7 @@ npx checkly deploy
 ```
 
 - `--config` or `-c`: You can specify a particular configuration file, e.g. `--config="./checkly.staging.config.ts"`
+- `--debug-bundle`: Generate a JSON file containing the data sent to our servers when you deploy.
 - `--force` or `-f`: Skips the confirmation dialog when deploying. Handy in CI environments.
 - `--preview` or `-p`: Preview the differences between your actual configuration and your account.
 - `--output` or `-o`: Show applied differences after deploying.
diff --git a/site/content/docs/cli/constructs-reference.md b/site/content/docs/cli/constructs-reference.md
@@ -26,7 +26,7 @@ export default defineConfig({
   checks: {
     activated: true,
     muted: false,
-    runtimeId: '2022.10',
+    runtimeId: '2025.04',
     frequency: Frequency.EVERY_5M,
     locations: ['us-east-1', 'eu-west-1'],
     tags: ['website', 'api'],
@@ -51,7 +51,7 @@ export default defineConfig({
 - `repoUrl`: An optional URL to a Git repository.
 
 - `checks`: Top-level defaults for all Checks in this Project. If not overridden at the Check or CheckGroup level, these
-settings apply to your Checks. Takes all [Check properties](#check)
+settings apply to your Checks. Takes all [Check properties](#check).
   - `checkMatch`: A glob pattern where the CLI should look for files containing Check constructs. For more info check [the
     dedicated docs on checkMatch and testMatch](/docs/cli/using-check-test-match/)
   - `ignoreDirectoriesMatch`: An array of glob patterns which directories should be ignored by the `checkMatch` property.
@@ -289,7 +289,7 @@ import * as path from 'path'
 
 new MultiStepCheck('multistep-check-1', {
   name: 'Multistep Check #1',
-  runtimeId: '2023.09',
+  runtimeId: '2025.04',
   frequency: Frequency.EVERY_10M,
   locations: ['us-east-1', 'eu-west-1'],
   code: {
@@ -939,7 +939,7 @@ new ApiCheck('local-api-1', {
 ## `RetryStrategy`
 
 `RetryStrategy` objects can be used to configure retries for failed check runs.
-Retry strategies can be added to [Check](#check) and [CheckGroup](#checkgroup) constructs.
+Retry strategies can be set at the [check](#check), [check group](#checkgroup), and [project](#project) levels.
 [Learn more about retry strategies](/docs/alerting-and-retries/retries/#retry-strategies).
 
 To build `RetryStrategy` objects you should use the `RetryStrategyBuilder`, which provides helper methods for configuring retries.
diff --git a/site/content/docs/cli/dynamic-check-creation.md b/site/content/docs/cli/dynamic-check-creation.md
@@ -109,7 +109,7 @@ export const groupPreview = new CheckGroup('group-browser-preview', {
   name: 'WebShop - Preview',
   activated: true,
   muted: false,
-  runtimeId: '2023.09',
+  runtimeId: '2025.04',
   locations: ['us-east-1', 'eu-west-1'],
   tags: ['mac', 'preview'],
   // You can use group-level environment vars to point each group's checks to the right target URL
@@ -123,7 +123,7 @@ export const groupProd = new CheckGroup('group-browser-prod', {
   name: 'WebShop - Production',
   activated: true,
   muted: false,
-  runtimeId: '2023.09',
+  runtimeId: '2025.04',
   locations: ['us-east-1', 'eu-west-1'],
   tags: ['mac', 'production'],
   // You can use group-level environment vars to point each group's checks to the right target URL
diff --git a/site/content/docs/cli/installation.md b/site/content/docs/cli/installation.md
@@ -45,7 +45,7 @@ export default defineConfig({
   checks: {
     activated: true,
     muted: false,
-    runtimeId: '2022.10',
+    runtimeId: '2025.04',
     frequency: Frequency.EVERY_5M,
     locations: ['us-east-1', 'eu-west-1'],
     tags: ['website', 'api'],
@@ -71,7 +71,7 @@ const config = {
   checks: {
     activated: true,
     muted: false,
-    runtimeId: '2022.10',
+    runtimeId: '2025.04',
     frequency: Frequency.EVERY_5M,
     locations: ['us-east-1', 'eu-west-1'],
     tags: ['website', 'api'],
diff --git a/site/content/docs/cli/project-structure.md b/site/content/docs/cli/project-structure.md
@@ -53,7 +53,7 @@ export default defineConfig({
   checks: {
     activated: true,
     muted: false,
-    runtimeId: '2022.10',
+    runtimeId: '2025.04',
     frequency: Frequency.EVERY_5M,
     locations: ['us-east-1', 'eu-west-1'],
     tags: ['website', 'api'],
@@ -84,7 +84,7 @@ const config = defineConfig({
   checks: {
     activated: true,
     muted: false,
-    runtimeId: '2022.10',
+    runtimeId: '2025.04',
     frequency: Frequency.EVERY_5M,
     locations: ['us-east-1', 'eu-west-1'],
     tags: ['website', 'api'],
diff --git a/site/content/docs/monitoring/how-we-store-data.md b/site/content/docs/monitoring/how-we-store-data.md
@@ -22,8 +22,8 @@ Depending on your plan we keep the results data according to the following reten
 
 |                               | Hobby            | Team             | Enterprise       |
 |-------------------------------|------------------|------------------|------------------|
-| **Raw data retention**        | 7                | 30               | 180              |
-| **Aggregated data retention** | 30               | 1 year           | 25 months        |
+| **Raw data retention**        | 7 days           | 30 days          | 180 days         |
+| **Aggregated data retention** | 30 days          | 1 year           | 25 months        |
 
 
 Simply put, you can "scroll back" within the defined period for raw data and inspect all the details of each result. After that, we store aggregates
diff --git a/site/content/docs/runtimes/specs.md b/site/content/docs/runtimes/specs.md
@@ -14,9 +14,7 @@ aliases:
 By default, all our runners have their timezone set to UTC, regardless of their location.
 
 ## Resource limitations
-Each Playwright-powered check (Browser and Multistep) can use up to `2.7 GiB` of memory and `1678m` [milli-CPU units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu)
-. This limit applies to all processes spawned by the check, including the browser, the test framework, and the test 
-code itself. The limit is enforced by the runner and is not configurable.
+Each Playwright-powered check (Browser and Multistep) can use up to `2.7 GiB` of memory and `1678m` [milli-CPU units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu). This limit applies to all processes spawned by the check, including the browser, the test framework, and the test code itself. The limit is enforced by the runner and is not configurable.
 
 > When the memory limit is exceeded, the check will automatically fail with a relevant error message, for example: 
 > `Your check has reached the maximum memory usage of 2.7 GiB`.
