docs: fix broken /docs/deployment/cloud/* links#10936
Conversation
The legacy paths /docs/deployment/cloud/{deployment-types,auto-suspension,
limits,scalability} now 404 on the live docs site, but were still used as
[ref-...] references throughout the docs and from external/cached links.
- Add redirects in docs.json from the four legacy paths to their current
/admin/deployment/* counterparts.
- Rewrite internal [ref-...] references in 12 MDX files to use the new
canonical /admin/deployment/* paths instead of going through redirects.
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @keydunov's task in 1m 45s —— View job Code Review: docs link fixes
Overall: Looks good. The PR correctly identifies the broken FindingsOne missed reference in a file this PR already touches (left inline comment):
Additional
These may or may not be broken (they use different sub-paths like Minor nit (inline comment): Three files ( SummaryThe core fix is correct and well-scoped. The one actionable item is the missed |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| @@ -340,7 +340,7 @@ Query History export. | |||
| </Note> | |||
There was a problem hiding this comment.
This file still has two other /docs/deployment/cloud/* references that weren't updated:
- Line 370:
/docs/deployment/cloud/warm-up#pre-aggregation-warm-up - Line 372:
/docs/deployment/cloud/deployments
The warm-up one is the same pattern as the four paths fixed in this PR — the page lives at /admin/deployment/warm-up now. Worth fixing here since you're already touching this file.
| </Note> | |
| [ref-autosuspend]: /admin/deployment/auto-suspension#effects-on-experience |
|
|
||
|
|
||
| [ref-limits]: /docs/deployment/cloud/limits#resources No newline at end of file | ||
| [ref-limits]: /admin/deployment/limits#resources No newline at end of file |
There was a problem hiding this comment.
Nit: missing trailing newline. The diff shows No newline at end of file — this pre-existed, but since you're touching this line anyway it'd be nice to add one.
| [ref-limits]: /admin/deployment/limits#resources | |
| [ref-limits]: /admin/deployment/limits#resources |
1 participant
Summary
A customer reported that https://docs.cube.dev/admin/deployment/deployment-types#deployment-types is broken. While investigating, I found:
#deployment-typesfragment in their URL doesn't match any heading on the page (section anchors are#shared,#dedicated,#multi-cluster,#switching-between-deployment-types), so the page just lands at the top instead of scrolling. Nothing in our codebase generates that exact fragment./docs/deployment/cloud/{deployment-types,auto-suspension,limits,scalability}now 404 on the live docs, but were still used as[ref-...]link references in 12 of our own MDX files. So every "learn more about deployment types / auto-suspension / limits / scalability" link from those pages was silently 404'ing.This PR:
docs-mintlify/docs.jsonmapping/docs/deployment/cloud/{deployment-types,auto-suspension,limits,scalability}→/admin/deployment/<same>, so any external/cached/customer-saved link keeps working.[ref-...]references in 12 MDX files to use the canonical/admin/deployment/*paths directly, so internal links no longer route through the redirect.Verified live status before/after of each path:
Test plan
mintlify dev --no-openboots without compile errors.mintlify broken-linksreports no new broken anchors.[ref-...]links resolve to live pages.curl -sI https://docs.cube.dev/docs/deployment/cloud/deployment-typesreturns a redirect to/admin/deployment/deployment-types.Made with Cursor