diff --git a/communicate/status-pages/creating-a-status-page.mdx b/communicate/status-pages/creating-a-status-page.mdx index 45aecfa0..84db7821 100644 --- a/communicate/status-pages/creating-a-status-page.mdx +++ b/communicate/status-pages/creating-a-status-page.mdx @@ -8,7 +8,7 @@ canonical: 'https://www.checklyhq.com/docs/communicate/status-pages/creating-a-s To set up a status page, select **New status page** on the [Status pages overview](https://app.checklyhq.com/status-pages). 1. Enter a name for your page. This name is used in the page header and in emails to subscribers. -2. Customize the subdomain slug for your page. Status pages use the domain `.checkly-status-page.com` by default. See [Custom domains](/communicate/status-pages/customization#custom-domain) to use your own domain. +2. Customize the subdomain slug for your page. Status pages use the domain `.checkly-status-page.com` by default. See [Custom domains](/communicate/status-pages/custom-domain) to use your own domain. 3. Add **components** for the parts of your product you want to report on. Use **Add group** to nest components under a shared heading, and drag to reorder. See [Components](/communicate/status-pages/overview#components). 4. Optionally set a logo, favicon, and theme. See [Customization](/communicate/status-pages/customization). 5. Click **Create status page**. You will see your page's details, and a link to the public version of the page below the title. diff --git a/communicate/status-pages/customization.mdx b/communicate/status-pages/customization.mdx index 4066169c..197196b3 100644 --- a/communicate/status-pages/customization.mdx +++ b/communicate/status-pages/customization.mdx @@ -1,6 +1,6 @@ --- title: "Status Page Customization" -description: "Change the logo, favicon, theme, and colors of your status page to match your brand." +description: "Change the logo, favicon, theme, colors, header and footer links, and search settings to match your brand." sidebarTitle: "Customization" canonical: 'https://www.checklyhq.com/docs/communicate/status-pages/customization/' --- @@ -51,3 +51,20 @@ brand guidelines, with separate palettes for light and dark mode under the **Lig | Border | Divider below the header and card borders | | Primary button background | Primary buttons, such as **Get updates** | | Primary button font | Text on primary buttons | + +## Header and footer + +In the **Header & Footer** settings of your status page: + +- **Support link**: shown as a "Contact Support" link in the page header. Use a URL or a `mailto:` address. +- **Footer text**: shown at the bottom of every page, for example a legal notice about your company. +- **Privacy policy link** and **Terms of service link**: shown as links in the page footer. + +## SEO and analytics + +In the **SEO & analytics** settings of your status page: + +- **Google Analytics tag**: your Google Analytics measurement ID, such as `G-XXXXXXXXXX`. Checkly adds the tracking script to your status page. +- **Allow search engines to index this page**: on by default. When you turn it off, the page asks search engines not to list it (with a `noindex` robots meta tag). This doesn't restrict access. To keep a page private, use [password protection](/communicate/status-pages/password-protection). + +To set these options in code, see the [StatusPageV3 construct](/constructs/status-page-v3). diff --git a/communicate/status-pages/incidents.mdx b/communicate/status-pages/incidents.mdx index 023c0b23..fbc89763 100644 --- a/communicate/status-pages/incidents.mdx +++ b/communicate/status-pages/incidents.mdx @@ -18,7 +18,7 @@ Create an incident when you want to communicate downtime or known issues to user 3. Enter the name of the incident. 4. Select which components are impacted, and the [impact](/communicate/status-pages/overview#component-status-and-impacts) each one gets: under maintenance, degraded performance, partial outage, or major outage. 5. Write the initial incident update message, and set the status of the incident. -6. If you want to backfill the incident, select `Use custom date`. See [Backfilling incidents for more information](/communicate/status-pages/incidents#backfilling-an-incident). +6. If you want to backfill the incident, select **Use custom date to backfill incident** under **Public date** and set the date shown on your status page. 7. Select if you want to notify subscribers of your Status Page about the incident. 8. Click ‘Create incident’ @@ -48,7 +48,7 @@ Overlapping phases never double-count: when several incidents impact the same co For example, a component with a 2-hour major outage and a separate 10-hour partial outage in the 90-day window accumulates 2 + (0.3 × 10) = 5 hours of downtime. -You can correct the record after the fact by editing a component's impact timeline on the incident, or by [backfilling an incident](/communicate/status-pages/incidents#backfilling-an-incident). Edited timelines must stay consistent: a phase ends after it starts, phases of the same component never overlap, and a resolved incident has no open phases. +You can correct the record after the fact by editing a component's impact timeline on the incident, or by [backfilling an incident](/communicate/status-pages/incidents#creating-an-incident). Edited timelines must stay consistent: a phase ends after it starts, phases of the same component never overlap, and a resolved incident has no open phases. ## Incident notifications diff --git a/communicate/status-pages/overview.mdx b/communicate/status-pages/overview.mdx index 9a9a524f..7839754a 100644 --- a/communicate/status-pages/overview.mdx +++ b/communicate/status-pages/overview.mdx @@ -22,7 +22,7 @@ Components come in two types: - **Service**: a monitored thing with its own status and uptime history. - **Group**: a container that nests services under a shared heading. A group shows the average uptime of its children. -Components belong to one status page. You manage them in the page's settings, where you can add, nest, reorder, hide, and delete them. +Components belong to one status page. You manage them in the page's settings, where you can add, nest, reorder, hide, and delete them. For each component you can also hide its historical data, which is shown by default, and you can show a group expanded when the page loads. Groups are collapsed by default, and a group needs at least one component. ![Component editor](/images/docs/images/status-pages-v3/status_page_v3_components.png) diff --git a/communicate/status-pages/password-protection.mdx b/communicate/status-pages/password-protection.mdx index 87c20ae4..3cd3106a 100644 --- a/communicate/status-pages/password-protection.mdx +++ b/communicate/status-pages/password-protection.mdx @@ -28,7 +28,7 @@ When someone visits a password-protected status page, they see a login form with - **Checkly account**: Members of the Checkly account that owns the status page can click **Sign in with Checkly account** to log in with their existing Checkly credentials. This does not require the shared password. After authenticating with either method, visitors are authenticated for **30 days** before needing to sign in again. -If your status page uses both a subdomain (`your-page.checkly-status-page.com`) and a [custom domain](/communicate/status-pages/customization#custom-domain), visitors need to log in separately on each domain. Authentication does not carry over between domains. +If your status page uses both a subdomain (`your-page.checkly-status-page.com`) and a [custom domain](/communicate/status-pages/custom-domain), visitors need to log in separately on each domain. Authentication does not carry over between domains. Only members of the Checkly account that owns the status page can use the **Sign in with Checkly account** option. Other Checkly users will be rejected. diff --git a/constructs/status-page-v3-automation-rule.mdx b/constructs/status-page-v3-automation-rule.mdx index 8965d73e..d98f63a3 100644 --- a/constructs/status-page-v3-automation-rule.mdx +++ b/constructs/status-page-v3-automation-rule.mdx @@ -71,7 +71,7 @@ Body of the status update that resolves the incident. -The components an automated incident impacts, with the impact each one gets. +The components an automated incident impacts, with the impact each one gets. The components must belong to the rule's status page. **Parameters:** @@ -111,7 +111,7 @@ Whether subscribers are notified of the automated updates. -Minimum minutes after an automated incident before this rule may open the next one. `0` disables the cool down. +Minimum minutes after an automated incident before this rule may open the next one. Must be a non-negative integer. `0` disables the cool down. diff --git a/constructs/status-page-v3-component.mdx b/constructs/status-page-v3-component.mdx index 0652a9f1..9ad1c75a 100644 --- a/constructs/status-page-v3-component.mdx +++ b/constructs/status-page-v3-component.mdx @@ -58,7 +58,7 @@ Position among its siblings; lower comes first. -`'SERVICE'` (a monitored thing with its own status) or `'GROUP'` (a container for other components). +`'SERVICE'` (a monitored thing with its own status) or `'GROUP'` (a container for other components). A group needs at least one component. **Usage:** @@ -80,6 +80,14 @@ Shown next to the name on the status page. Hide the component from the public page while keeping it available for incidents and automation. + +Show the component's historical data on the status page. + + + +Only for `GROUP` components. Show the group expanded when the status page loads. + + The `GROUP` component to nest this component under. Must be on the same status page. diff --git a/constructs/status-page-v3.mdx b/constructs/status-page-v3.mdx index 0a01b712..c5f185fa 100644 --- a/constructs/status-page-v3.mdx +++ b/constructs/status-page-v3.mdx @@ -122,7 +122,7 @@ new StatusPageV3("company-status", { -Custom domain for your status page (e.g., `status.example.com`). Requires DNS configuration and domain verification. See [Custom domains](/communicate/status-pages/customization#custom-domain). +Custom domain for your status page (e.g., `status.example.com`). Requires DNS configuration and domain verification. See [Custom domains](/communicate/status-pages/custom-domain). **Usage:** @@ -168,7 +168,7 @@ Link to your terms of service, shown in the page footer. -Link to your support channel, shown in the page footer. +Link to your support channel, shown as a "Contact Support" link in the page header. Use a URL or a `mailto:` address.