Skip to content

docs: fix broken links to Update channels page and fix HEIC image#10880

Draft
keydunov wants to merge 1 commit into
masterfrom
cursor/fix-update-channels-docs-links-fd60
Draft

docs: fix broken links to Update channels page and fix HEIC image#10880
keydunov wants to merge 1 commit into
masterfrom
cursor/fix-update-channels-docs-links-fd60

Conversation

@keydunov
Copy link
Copy Markdown
Member

Check List

  • Tests have been run in packages where changes have been made if available
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet
  • Docs have been added / updated if required

Issue Reference this PR resolves

CUB-2581

Description of Changes Made

Fixes two issues on the Update channels documentation page:

1. Broken links to Update channels section

Several documentation pages referenced /admin/deployment/deployments#update-channels, but the page deployments.mdx doesn't exist in the Mintlify docs — the content lives in admin/deployment/index.mdx. Fixed references in:

  • docs-mintlify/admin/account-billing/distribution.mdx — updated link ref to /admin/deployment/index#update-channels
  • docs-mintlify/admin/deployment/environments.mdx — updated both ref-version and ref-version-channel to point to /admin/deployment/index
  • docs/content/product/administration/deployment/environments.mdx (old docs) — fixed incorrect path prefix (/product/deployment/cloud//product/administration/deployment/)

2. Broken image on Update channels section

The screenshot image (ucarecdn.com/3ef5fa36-...) is stored in HEIC format, which browsers cannot render natively. Appended ucarecdn's -/format/auto/ processing suffix so the CDN serves it as JPEG instead. Fixed in both:

  • docs-mintlify/admin/deployment/index.mdx
  • docs/content/product/administration/deployment/deployments.mdx

Note: The "Learn more" link shown in the Cube Cloud Settings UI under "Update channel" points to the same broken URL (/admin/deployment/deployments#update-channels). That link lives in the enterprise/console-ui codebase and should be updated separately to point to /admin/deployment/index#update-channels.

Linear Issue: CUB-2581

Open in Web Open in Cursor 

- Fix broken link references pointing to non-existent /admin/deployment/deployments
  page, redirect them to /admin/deployment/index (Mintlify docs)
- Fix broken link references in old docs (environments.mdx) using wrong path prefix
- Fix broken image on Update channels section: the ucarecdn asset is in HEIC format
  which browsers cannot render; append -/format/auto/ to serve as JPEG

Fixes CUB-2581

Co-authored-by: Artyom Keydunov <artyom.keydunov@gmail.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 14, 2026

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

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview May 14, 2026, 3:35 AM

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

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 14, 2026

Claude finished @keydunov's task in 1m 16s —— View job


Code Review: docs: fix broken links to Update channels page and fix HEIC image

  • Gather context and review diff
  • Verify link targets exist
  • Verify image URL fix
  • Post review

Overall: Looks good. The changes are correct and well-scoped. The link fixes point to files that actually exist, and the ucarecdn -/format/auto/ suffix is the right approach for the HEIC rendering issue. A few observations below.

Changes verified

File Change Verified
docs-mintlify/admin/account-billing/distribution.mdx /admin/deployment/deployments#update-channels/admin/deployment/index#update-channels ✅ Target file exists, anchor ### Update channels confirmed at line 137
docs-mintlify/admin/deployment/environments.mdx Two refs updated to /admin/deployment/index#... ✅ Both anchors (## Cube version L122, ### Update channels L137) exist
docs-mintlify/admin/deployment/index.mdx Added -/format/auto/ to ucarecdn image URL ✅ Correct ucarecdn processing syntax
docs/content/.../deployments.mdx Same image URL fix
docs/content/.../environments.mdx /product/deployment/cloud/deployments#.../product/administration/deployment/deployments#... ✅ Target docs/content/product/administration/deployment/deployments.mdx exists

Issues found

1. Missed broken links in Mintlify docs (same pattern)

There are two more files referencing the non-existent /admin/deployment/deployments path that this PR doesn't fix:

  • docs-mintlify/admin/deployment/auto-suspension.mdx:127[ref-cube-version]: /admin/deployment/deployments#cube-version → should be /admin/deployment/index#cube-version
  • docs-mintlify/reference/control-plane-api.mdx:263[ref-deployments]: /admin/deployment/deployments → should be /admin/deployment/index

Fix these →

2. Mintlify environments.mdx still has other /docs/deployment/cloud/ links

While this PR correctly fixed the two deployments references, lines 116–122 of docs-mintlify/admin/deployment/environments.mdx still contain several other /docs/deployment/cloud/... path references (e.g., deployment-types, scalability, auto-suspension). These may also be broken depending on Mintlify's routing. Worth a quick check, but out of scope for this PR.

3. Missing trailing newline

All five changed files are missing a trailing newline (the diff shows \ No newline at end of file). This is a pre-existing issue, not introduced by this PR, but worth noting.

Summary

The PR correctly fixes the specific broken links and image rendering issues it targets. The only actionable finding is the two additional broken /admin/deployment/deployments references in auto-suspension.mdx and control-plane-api.mdx that follow the exact same pattern. Consider including those in this PR for completeness.

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.

2 participants