docs: fix the broken links on the documentation home page and across the tree - #8491
Conversation
Nine feature tiles, three of which pointed at the wrong page and one of which pointed nowhere at all: - Pipelines went to Snapshots - Remote Instances and High Availability both went to Device Groups - Upgrading Teams had an empty href - Managing Teams carried Custom Domains' description Community Support has a page and a nav entry but was never linked from here, so it is added alongside Troubleshooting and Cloud Support. The four FlowFuse Nodes links were absolute URLs into /node-red/flowfuse/, which the website now 301s into /docs/flowfuse-nodes/. They point at the destination directly.
56 links across 20 pages were written as /docs/user/snapshots.md rather than /docs/user/snapshots/. The docs site has no .md routes, so every one of them 404s; verified against production before and after. README.md and index.md resolve to their directory rather than to a /README/ path, and anchors are preserved.
The docs link check resolves a /-prefixed link against this repository's own tree. /docs/flowfuse-nodes/ is served by FlowFuse/website, so it has no file here and the check reports it missing. Absolute URLs are validated over HTTP instead, which is what these pages need.
dcd973f to
2a1d8f6
Compare
|
Correcting something I claimed in this PR's description, after finding the mechanism I had missed. The My "verified against production" check fetched What the second commit actually does, then: it makes the source match the URL the site serves, and skips a redirect hop. That is a small real improvement and nothing in the tree regressed, but it is a tidy-up, not a bug fix, and the description oversold it. The first commit stands. Those were genuinely wrong: an empty Worth recording for anyone who looks at this later: the same plugin means ~160 relative |
Two mechanical link fixes. No page's content or URL changes.
1. The documentation home page had four tiles pointing at the wrong page, or at nothing.
/docs/user/snapshots//docs/user/devops-pipelines//docs/user/device-groups//docs/device-agent/introduction//docs/user/device-groups//docs/user/high-availability/href=""/docs/cloud/billing/#team-billing2. 56 links across 20 pages were written as
/docs/user/snapshots.mdrather than/docs/user/snapshots/. The docs site has no.mdroutes, so every one of them 404s today.The rest of the detail
Also on the home page
alongside Troubleshooting and Cloud Support.
/node-red/flowfuse/, which thewebsite now 301s into
/docs/flowfuse-nodes/. They point at the destination directly.On the
.mdlinksVerified against production before and after:
README.mdandindex.mdresolve to their directory rather than to a/README/path, andanchors are preserved. Every
/docs/link in the tree, markdown and HTML, now resolves to afile that exists.
Why the FlowFuse Nodes links stayed absolute
test/e2e/docs/valid-links.jsresolves a/-prefixed link against this repository'stree.
/docs/flowfuse-nodes/is served fromFlowFuse/website, so it has no file here andthe check reports it missing. Absolute URLs are validated over HTTP instead, which is what
those pages need.
Worth noting the same check passes a link written as
/docs/user/snapshots.md, because thefile does exist on disk. It validates the source tree, not the URL space, which is why these
56 links survived this long.
One thing left for someone who knows
No page documents upgrading a team's tier. Upgrading Teams points at the closest section
that exists rather than at the page it implies.