Skip to content

docs: status page maintenance plans and uptime on v3 pages (DOC-147) - #741

Merged
hlenke merged 2 commits into
mainfrom
docs-audit/doc-147-maintenance-windows
Oct 28, 2026
Merged

hlenke merged 2 commits into
mainfrom
docs-audit/doc-147-maintenance-windows

Conversation

@hlenke

@hlenke hlenke commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

Fixes DOC-147.

The status page maintenance page was mostly right, but two things were wrong.

1. Which plans include it. The page said status page maintenance is part of "the Communicate add-on". It's only included in Communicate Team, not Hobby or Starter, and Enterprise (contract) accounts always have it. The note and the prerequisite now say "Communicate Team and Enterprise plans", the same wording the other status page pages use.

2. Uptime. The page said that incident downtime during a maintenance is left out of your status page uptime. On today's status pages (v3) that isn't true: downtime during a maintenance counts like any other downtime. The page now says so. I also removed a bullet that only made sense under the old claim.

How it was proven

Claim Proof
v3 pages support status page maintenance Checkly's own status page (v3) shows maintenance in production (example). The component support was added in a 2026-08-05 migration
Plans communicate-team.ts includes the feature, communicate-hobby.ts and communicate-starter.ts don't, and contract accounts are always entitled (plan-overrides.ts)
Uptime on v3 isn't adjusted for maintenance On a local stack I created a v3 page and a maintenance that covered all its components, waited until it was in progress, then opened a major outage during it. After 626 seconds, the status page's own uptime endpoint returned 99.992. That is exactly 626 s of downtime over 90 days; with the exclusion it would have been 100. The v3 uptime code also has a TODO saying maintenance isn't subtracted yet

npm run check:links and vale pass. An independent reviewer checked the diff against the code and the measurement and found nothing wrong. Its optional v2 aside was applied and then removed in review, because the page covers v3. The proof resources were deleted afterwards.

Noticed, not changed

  • The public API (POST /v1/maintenance-windows) can't attach a maintenance to a v3 page. It answers "The selected status pages have no services", because it only understands v2 services. The Checkly app uses an internal field (componentConfigs) instead. That's a product gap, not a docs error.
  • The code comment in uptime-calculations.ts says "v3 pages ship without maintenance window support for now". That's stale: maintenance works on v3, only the uptime part is missing.
  • I didn't verify line 61's mention of maintenance on the 90-day availability chart.

🤖 Generated with Claude Code

- Status page maintenance is included in Communicate Team and Enterprise, not
  every Communicate add-on (Hobby and Starter don't include it).
- Maintenance doesn't change status page uptime: on v3 pages, incident downtime
  that overlaps a maintenance counts like any other downtime. Measured on the
  local stack: a 626 s major outage during an in-progress maintenance brought
  the component's uptime to 99.992 (no exclusion).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Oct 28, 2026, 8:16 PM

</Note>

Incident downtime that overlaps a published maintenance period is excluded from your status page **uptime**. Windows with [**Show affected components**](#hiding-affected-components) turned off are the exception: their overlapping downtime still counts.
Maintenance doesn't change your status page **uptime**: incident downtime that overlaps a maintenance counts the same as any other downtime. (On deprecated v2 pages, overlapping downtime is still excluded when **Show affected components** is on.)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leave this out: (On deprecated v2 pages, overlapping downtime is still excluded when Show affected components is on.)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@hlenke
hlenke marked this pull request as ready for review October 28, 2026 20:16
@hlenke
hlenke enabled auto-merge October 28, 2026 20:16
@hlenke
hlenke disabled auto-merge October 28, 2026 20:16
@hlenke
hlenke enabled auto-merge October 28, 2026 20:16
@hlenke
hlenke merged commit e54fed1 into main Oct 28, 2026
6 of 9 checks passed

This branch was successfully deployed

1 active deployment
staging — 12b7e928 Deployed Oct 28, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant