Skip to content

Commit 5d3976f

Browse files
authored
Merge branch 'main' into michelleliebheit/fix-typos
2 parents 980f9e1 + 9361f12 commit 5d3976f

35 files changed

Lines changed: 1806 additions & 989 deletions

.github/pull_request_template.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Affected Components
2+
3+
* [ ] Content & Marketing
4+
* [ ] Pricing
5+
* [ ] Test
6+
* [ ] Docs
7+
* [ ] Learn
8+
* [ ] Other
9+
10+
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
11+
## Notes for the Reviewer
12+
<!-- Anything the reviewer should pay extra attention to. -->
13+
14+
## New Dependency Submission
15+
<!-- Please explain here why we need the new dependency. -->
16+
17+
## Screenshots
18+
<!-- Screenshot of any visual changes -->

admin/changing-your-email-password.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Changing your email or password in Checkly"
33
description: "Learn how to change your email address or password in your Checkly account"
4-
sidebarTitle: "Changing Your Email"
4+
sidebarTitle: "Changing Email or Password"
55
---
66

77
Changing your email and / or password is handled differently depending on how you signed up for Checkly. Please check below for the scenario that applies to you:
@@ -20,7 +20,7 @@ The simplest way to achieve this is to:
2020
5. Optionally, remove your "old" user from the account.
2121

2222
<Warning>
23-
This method won't work if you're on the Hobby plan or have reached your user limit. If you run into this or other issues, contact support for help.
23+
This method won't work if you're on the Hobby plan or have reached your user limit. If you run into this or other issues, contact [support@checklyhq.com](mailto:support@checklyhq.com) for help.
2424
</Warning>
2525

2626
## Changing your password
@@ -37,4 +37,8 @@ To change your password, follow these steps:
3737
4. Click the **Forgot password?** link.
3838
5. Follow the instructions to reset your password.
3939

40-
After successfully resetting your password, you can log in with your new password.
40+
After successfully resetting your password, you can log in with your new password.
41+
42+
<Note>
43+
If your reset password email never arrives, this may be because you originally logged in with Google or Github. If you need help accessing your account, please reach out to [support@checklyhq.com](mailto:support@checklyhq.com).
44+
</Note>

admin/creating-api-key.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ When a user is removed from your account, that user's API keys are no longer abl
1313

1414
**Steps to create an user API key:**
1515

16-
1. Go to the API keys section in the [User Settings](https://app.checklyhq.com/settings/user/).
17-
2. Click **Create new API key**.
16+
1. Go to the API keys section in the [User Settings](https://app.checklyhq.com/settings/user/api-keys).
17+
2. Click **Create API key**.
1818
3. Enter a name for the API key in the dialog box and confirm.
1919
4. The new API key is shown and can be copied. Make sure to copy it immediately as it won't be shown again.
2020

@@ -30,16 +30,16 @@ curl -H "Authorization: Bearer my_user_api_key" -H "X-Checkly-Account: my_accoun
3030

3131
### Deleting a user API key
3232

33-
Only the user can delete an API key. To delete an API key click on the **Delete** icon in the Api Keys section of the [User Settings](https://app.checklyhq.com/settings/user/).
34-
If you wish to revoke access of a user to an account, remove the user from the team in the [Team section of Account Settings](https://app.checklyhq.com/settings/account/team).
33+
Only the user can delete an API key. To delete an API key click on the **Delete** icon in the Api Keys section of the [User Settings](https://app.checklyhq.com/settings/user/api-keys).
34+
If you wish to revoke access of a user to an account, remove the user from the team in the [Members section of Account Settings](https://app.checklyhq.com/settings/account/team).
3535

3636
## Service API keys
3737

3838
Service API keys are specific to one account and are not tied to a user. This means that service API keys can be used to access your account even if the user that created the API key is removed from your account.
3939

40-
<Info>
40+
<Note>
4141
Service API keys are available on the [Enterprise plan](https://www.checklyhq.com/pricing/) only
42-
</Info>
42+
</Note>
4343

4444
Service API keys allow you to set a role access level on the key itself, e.g. "read only", "admin" etc.
4545

admin/team-management/adding-team-members.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Learn how to invite team members to join your Checkly account and
44
sidebarTitle: "Adding Team Members"
55
---
66

7-
You can invite team members to join your Checkly account to view and manage all checks and related settings; team members can have different [roles](platform/admin/overview).
7+
You can invite team members to join your Checkly account to view and manage all checks and related settings; team members can have different [roles](/admin/team-management/overview).
88

99
## Inviting team members
1010

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
---
2-
title: "Using Microsoft Azure AD for Single Sign-on in Checkly"
3-
description: "Learn how to configure Microsoft Azure AD SSO integration with Checkly"
4-
sidebarTitle: "MS Active Directory"
2+
title: "Using Microsoft Entra ID for Single Sign-on in Checkly"
3+
description: "This page illustrates the standard procedure to follow in order to get started with Microsoft Entra ID SSO (formerly Azure AD) on Checkly. "
4+
sidebarTitle: "Microsoft Entra ID"
55
---
66

7-
This page illustrates the standard procedure to follow in order to get started with Microsoft Azure AD SSO on Checkly.
8-
97
## Initial SSO configuration
108

119
Setting up SSO for your organisation starts with providing [Checkly Support](mailto:support@checklyhq.com) with the following information:
1210

13-
- Microsoft Azure AD Domain (e.g. company.com)
11+
- Microsoft Entra ID Domain (e.g. company.com)
1412
- [Client ID](https://auth0.com/docs/connections/enterprise/azure-active-directory)
1513
- Client Secret
1614

@@ -23,5 +21,5 @@ After configuration has taken place on Checkly's side, you will receive confirma
2321
After submitting the Checkly login form, you should be redirected to your SSO login interface. Completing the login procedure will then lead you to your existing Checkly account, if you have one, or to the new account creation screen, in case you don't.
2422

2523
<Info>
26-
Once Microsoft Azure AD has been set up, you will still need to invite new users from your organization to your Checkly account, as they will not be added automatically.
24+
Once Microsoft Entra ID has been set up, you will still need to invite new users from your organization to your Checkly account, as they will not be added automatically.
2725
</Info>

admin/team-management/multi-factor-authentication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Checkly supports MFA using one time passwords generated by a separate authentica
1414
- Toggle 'Enable multi-factor authentication'.
1515
- Log out of your account and log back in.
1616
- When prompted, scan the QR code using one of the supported apps:
17-
- Authy ([Google Play](https://play.google.com/store/apps/details?id=com.authy.authy) / [App Store](https://itunes.apple.com/us/app/authy/id494168017))
17+
- Twilio Authy ([Google Play](https://play.google.com/store/apps/details?id=com.authy.authy) / [App Store](https://itunes.apple.com/us/app/authy/id494168017))
1818
- Auth0 Guardian ([Google Play](https://play.google.com/store/apps/details?id=com.auth0.guardian) / [App Store](https://itunes.apple.com/us/app/auth0-guardian/id1093447833))
1919
- Google Authenticator ([Google Play](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) / [App Store](https://itunes.apple.com/us/app/google-authenticator/id388497605))
2020
- Microsoft Authenticator ([Google Play](https://play.google.com/store/apps/details?id=com.azure.authenticator) / [App Store](https://itunes.apple.com/us/app/microsoft-authenticator/id983156458))

admin/team-management/overview.mdx

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebarTitle: "Overview"
66

77
This section covers all aspects of administering your Checkly account, from managing team members and permissions to setting up advanced security features and API access.
88

9-
## Team Roles
9+
## Team Member Roles
1010

1111
When inviting a team member to join your account you can assign one of four roles that all have different access patterns.
1212

@@ -33,7 +33,7 @@ Roles are staggered, so any role higher up the totem pole has all the rights of
3333

3434
Learn how to invite new users to your account and manage their access levels.
3535

36-
[Learn more about adding team members](admin/team-management/adding-team-members)
36+
[Learn more about adding team members](/admin/team-management/adding-team-members)
3737

3838
### Transferring Ownership
3939

@@ -45,37 +45,29 @@ If you have the **Owner** role, you can transfer the ownership to another team m
4545

4646
Manage your login credentials and account information securely.
4747

48-
[Learn about changing your email or password](admin/changing-your-email-password)
48+
[Learn about changing your email or password](/admin/changing-your-email-password)
4949

5050
## Security
5151

5252
### Multi-Factor Authentication
5353

5454
Add an extra layer of security to your account with MFA using authenticator apps.
5555

56-
[Set up multi-factor authentication](admin/team-management/multi-factor-authentication)
56+
[Set up multi-factor authentication](/admin/team-management/multi-factor-authentication)
5757

5858
### Single Sign-On (SSO)
5959

6060
For enterprise customers, Checkly supports SSO integration with your existing identity provider.
6161

62-
[Learn about SSO options](admin/team-management/single-sign-on)
63-
64-
**Available SSO Protocols:**
65-
- [SAML](admin/team-management/saml) - Generic SAML 2.0 integration
66-
- [Microsoft Azure AD](admin/team-management/microsoft-azure-ad) - Direct Azure AD integration
67-
68-
<Note>
69-
SSO is only available for Checkly's [enterprise plans](https://www.checklyhq.com/pricing/).
70-
</Note>
62+
[Learn about SSO options](/admin/team-management/single-sign-on)
7163

7264
## API Access
7365

7466
### Creating API Keys
7567

7668
Generate API keys for programmatic access to your Checkly account through the REST API and CLI.
7769

78-
[Learn about creating and managing API keys](admin/team-management/creating-api-key)
70+
[Learn about creating and managing API keys](/admin/creating-api-key)
7971

8072
**API Key Types:**
8173
- **User API Keys** - Tied to individual users with inherited permissions
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: "Single Sign-on in Checkly"
33
description: "Overview of Single Sign-On (SSO) options available in Checkly for enterprise security"
4-
sidebarTitle: "Single Sign-On"
4+
sidebarTitle: "Overview"
55
---
66

77
Single Sign-On (SSO) enables businesses to secure employee access across a variety of third-party services. Currently, Checkly supports the following SSO protocols:
88

9-
1. [SAML](admin/team-management/saml)
10-
2. [Microsoft Azure AD](admin/team-management/microsoft-azure-ad)
9+
1. [SAML](/admin/team-management/saml)
10+
2. [Microsoft Entra ID](/admin/team-management/microsoft-azure-ad) (formerly Azure AD)
1111

1212
If you are interested in using Checkly with a different SSO protocol, please [reach out to Support](mailto:support@checklyhq.com).
1313

1414
<Note>
15-
SSO is only available for Checkly's [enterprise plans](/pricing/).
15+
SSO is only available for Checkly's [enterprise plans](https://www.checklyhq.com/pricing/).
1616
</Note>
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: 'Await completion of a check session'
3+
openapi: 'GET /v1/check-sessions/{checkSessionId}/completion'
4+
description: 'Wait for a check session to finish and get final results'
5+
---
6+
7+
## Overview
8+
9+
Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes or fails).
10+
11+
If the check session takes a long time to complete, the endpoint will return a timeout error code (see `maxWaitSeconds` parameter below).
12+
13+
You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.
14+
15+
The successful response of this endpoint is equivalent to the `GET /v1/check-sessions/{checkSessionId}` endpoint's response for a completed check session.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: 'Retrieve a check session'
3+
openapi: 'GET /v1/check-sessions/{checkSessionId}'
4+
description: 'Fetch details for a check session'
5+
---
6+
7+
## Overview
8+
9+
Retrieves a check session. Results may be incomplete if the session is still in progress.
10+
11+
Results for all finished check runs are included, with one result per run location. Each result contains enough data to quickly determine success or failure.
12+
13+
For detailed information on a specific result, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint.

0 commit comments

Comments
 (0)