HDDS-15124. [Docs] Fix broken /docs/current/ links in CONTRIBUTING.md and dist/README.md#10153
Merged
adoroszlai merged 1 commit intoapache:masterfrom Apr 29, 2026
Merged
Conversation
… and dist/README.md Updates four broken https://ozone.apache.org/docs/current/...html documentation links that returned 404 after the docs site moved from Hugo to Docusaurus (eliminating the current/ namespace and .html suffix). Each link is repointed at the equivalent Docusaurus page, choosing targets that match the audience and link-text framing of the surrounding paragraph: - CONTRIBUTING.md:78 (Docker Compose) -> /docs/developer-guide/run/docker-compose/ The surrounding text walks contributors through building from source and running the in-tree compose; the dev-guide page documents that exact flow, starting with the same `cd ./hadoop-ozone/dist/target/ozone-<VERSION>/compose/ozone` step. - dist/README.md:33,41,42 -> /docs/quick-start/installation/{docker,kubernetes,kubernetes/#minikube} Both the link text ("Getting Started: ...") and the surrounding intro ("More information can be found in the Getting Started Guide:") explicitly invoke the Quick Start framing, so the URLs match those labels. Out of scope: broken /docs/edge/...html links and the OEP link on CONTRIBUTING.md:98 -- both are covered by HDDS-14663 / apache/ozone-site#351, which restores /docs/edge/ as a frozen archive.
jojochuang
approved these changes
Apr 28, 2026
Contributor
jojochuang
left a comment
jojochuang
left a comment
There was a problem hiding this comment.
Thanks. I wanted to restore the current link in the site doc but that PR is not being reviewed.
Contributor
|
Thanks @chihsuan for the patch, @jojochuang for the review. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Updates four broken
https://ozone.apache.org/docs/current/...htmllinks that404 after the docs site moved from Hugo to Docusaurus (the
current/namespaceand
.htmlsuffix were dropped).URL mapping
CONTRIBUTING.md:78…/docs/current/start.html…/docs/developer-guide/run/docker-compose/dist/README.md:33…/docs/current/start/runningviadocker.html…/docs/quick-start/installation/docker/dist/README.md:41…/docs/current/start/minikube.html…/docs/quick-start/installation/kubernetes/#minikubedist/README.md:42…/docs/current/start/kubernetes.html…/docs/quick-start/installation/kubernetes/Why these targets
The two files target different audiences, so the same "Docker Compose" topic
maps to different pages:
CONTRIBUTING.md:78— Surrounding text walks contributors throughbuilding from source and running the in-tree compose. The dev-guide page
documents that exact flow, opening with the same
cd ./hadoop-ozone/dist/target/ozone-<VERSION>/compose/ozonecommand.dist/README.md:33,41,42— Both the link text ("Getting Started: ...")and the surrounding intro (
"More information can be found in the Getting Started Guide:") explicitly invoke the Quick Start framing, so the URLsmatch those labels.
Out of scope
…/docs/edge/...htmllinks and the OEP link onCONTRIBUTING.md:98— covered by HDDS-14663 / HDDS-14663. [Docs] Fix broken links ozone-site#351,which restores
/docs/edge/as a frozen archive.What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-15124
How was this patch tested?
docs/02-quick-start/01-installation/02-kubernetes.md(with a## Minikubeheading for the anchor)
docs/08-developer-guide/02-run/02-docker-compose.mddocs/02-quick-start/01-installation/README.mdxbuild-branchCI on the fork: docs / RAT / checkstyle / PMD / findbugs /acceptance jobs all green. Two integration jobs hit known flakes:
integration (recon)cleared on rerun (transient).integration (hdds)→TestDeadNodeHandler.testOnMessageis the failuretracked by HDDS-14977 (Open).