Skip to content

docs: explain how to check whether a deployment is suspended - #11725

Merged
igorlukanin merged 2 commits into
masterfrom
igor/cub-4062-document-checking-suspension-state
Sep 2, 2026
Merged

docs: explain how to check whether a deployment is suspended#11725
igorlukanin merged 2 commits into
masterfrom
igor/cub-4062-document-checking-suspension-state

Conversation

@igorlukanin

Copy link
Copy Markdown
Member

Opening a deployment in Cube Cloud resumes it, and that was the only documented way to check on one — so there was no way to tell whether a deployment was suspended without changing the answer. This adds a section explaining where to look instead, and warns about the resume side effect.

It also points at Cost and Usage Explorer for the related question the same gap blocks: finding deployments that are genuinely unused, rather than merely suspended at this moment.

The Deployments page grows a Status column in a companion change; this documents it.

@mintlify

mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview Sep 1, 2026, 9:37 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@claude

claude Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 1m 39s —— View job


Docs review — no blockers; 3 low-severity notes (naming, duplication, unverifiable UI path)

Full review
  • Read PR diff
  • Check link reference definitions & docs conventions
  • Cross-check UI paths and terminology against the rest of docs-mintlify
  • Post review

What's good

  • [ref-prod-multi-cluster] is already defined at line 138 — no dangling link references introduced.
  • The section is placed sensibly, right before Resuming a suspended deployment, and the warning is consistent with that section's "navigating to the deployment" resume path.
  • The framing is genuinely useful: it answers the observability question and the adjacent "is this deployment actually unused?" question the same gap blocks.
  • Concise — no padding, no new page where a section does the job.

Findings (all inline)

# Line(s) Severity Issue
1 96–102 Low "Cube Cloud" is legacy naming per docs-mintlify/CLAUDE.md; new content should use "Cube".
2 104–110 Low Multi-cluster exemption is already stated in the <Info> at line 26; "Shared" and "CCU" are unlinked here though both have existing link refs on the page.
3 108 Low Billing → Cost and Usage Explorer is the only occurrence of that UI path in the whole docs set — no other page documents the Cost and Usage Explorer, and every other nav path in these docs uses an Admin → … prefix. Only you can verify the label.

Aside (pre-existing, not this PR)

auto-suspension.mdx carries hidden: true in its frontmatter while also being registered in docs.json (line 316). Not introduced here, but worth knowing that the new section inherits whatever visibility that combination produces.

· [Branch](https://github.com/cube-js/cube/tree/igor/cub-4062-document-checking-suspension-state)

Comment thread docs-mintlify/admin/deployment/auto-suspension.mdx
Comment thread docs-mintlify/admin/deployment/auto-suspension.mdx Outdated
Comment thread docs-mintlify/admin/deployment/auto-suspension.mdx Outdated
@claude

claude Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 53s —— View job


Re-review after update — all 3 prior notes addressed; no new findings

Full review
  • Read updated diff (9f688b9)
  • Re-check the three prior threads against current content
  • Verify link reference definitions resolve
  • Resolve stale threads, post summary

Prior notes — all resolved in 9f688b9

# Note Status
1 "Cube Cloud" legacy naming in the new <Warning> Fixed — now "Opening a deployment in Cube resumes it" (line 98)
2 Multi-cluster reason duplicated the <Info> at line 26; Shared / CCU unlinked Fixed — the paragraph now leads with the Always on label and covers both cases (Multi-cluster, plus Dedicated with auto-suspension off), and [Shared deployment][ref-deployment-dev-instance] / [CCU][ref-deployment-pricing] are linked (lines 104–113)
3 Billing → Cost and Usage Explorer label unverifiable from the docs set Relabeled to Billing → Cost and Usage (line 110). Still the only occurrence of that path in docs-mintlify, so nothing to cross-check against — taking your verification as authoritative

All three threads resolved.

Link references

All four refs used in the new section are defined at the bottom of the page:
ref-prod-multi-cluster (141), ref-deployment-prod-cluster (140),
ref-deployment-dev-instance (139), ref-deployment-pricing (142). No dangling
references.

No new findings

The added paragraph on Always on is more accurate than what I suggested — it
covers the Dedicated-with-auto-suspension-off case my version missed. Section
length and placement still look right.

Aside (pre-existing, not this PR)

  • Line 26: typo — "not avaiable" → "not available".
  • Frontmatter carries hidden: true while the page is registered in docs.json
    (line 316); the new section inherits whatever that combination produces.
· [Branch](https://github.com/cube-js/cube/tree/igor/cub-4062-document-checking-suspension-state)

@igorlukanin
igorlukanin merged commit aca4243 into master Sep 2, 2026
9 checks passed
@igorlukanin
igorlukanin deleted the igor/cub-4062-document-checking-suspension-state branch September 2, 2026 13:24
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