HDDS-14663. [Docs] Fix broken links#351
Conversation
|
Is this still needed? |
|
@smengcl yes let me update this PR. |
|
I'll have to redo this again. A lot of change went in that breaks this one. |
chihsuan
left a comment
chihsuan
left a comment
There was a problem hiding this comment.
Hi @jojochuang 👋 I'm jumping in to help review this PR. promptly. Hope that's helpful so we can get the fix merged —please feel free to disregard if not needed. 🙏
I was reading through and ran the branch locally. Sharing a couple of observations:
docusaurus / build-website CI is failing
The issue seems to be that src/pages/index.jsx:464 still links to /download, which I think 404s after the rename to /downloads. I can reproduce the issue locally with pnpm build and verified that updating it would fix the issue.
Something I noticed when testing pnpm build && pnpm serve
The entry page /docs/edge and 2-level pages like /docs/edge/start rendered without styles for me; deeper pages were fine. See the recording below. Looked like Hugo's relative paths combined with serve-handler's cleanUrls and a missing trailing-slash redirect.
My best guess is that this is a local-only artifact, and that Apache HTTPD in production handles it correctly (its defaults are the opposite), so the site likely works as deployed. Not raising it as a blocker — just wanted to mention what I saw in case it's useful context.
Screen.Recording.2026-04-29.at.9.38.46.PM.mov
| }, | ||
| { | ||
| to: 'download', | ||
| to: 'downloads', |
There was a problem hiding this comment.
This renaming creates new broken external links for anything that's bookmarked or indexed, pointing to the old paths.
/release-notes/* renaming will also likely 404 after the rename. Was a redirect considered (e.g. via @docusaurus/plugin-client-redirects)?
| sidebar_label: Release Notes | ||
| --- | ||
|
|
||
| This page contains the release notes for Apache Ozone. Please navigate to the specific version to view its release notes. |
There was a problem hiding this comment.
I've noticed that when visiting this page, we aren't able to navigate directly to a specific version. Was this an intentional design choice?
Perhaps we should add a version list (for example: - Apache Ozone 2.1.0 — 2025-12-31...). Alternatively, linking prominently to the /downloads page might be helpful. Since the Downloads table already lists each version with its corresponding release notes link, this page wouldn't need to repeat that information or require updates with each new release. Just share a few thoughts.
3 participants
What changes were proposed in this pull request?
HDDS-14663. [Docs] Fix broken links
Please describe your PR in detail:
What is the link to the Apache Jira?
https://issues.apache.org/jira/browse/HDDS-14663
How was this patch tested?
Please explain how this patch was tested. In most cases this will just be checking the local preview of the website, but existing CI checks should also pass.