[
https://issues.apache.org/jira/browse/HDDS-15124?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18076563#comment-18076563
]
Chi-Hsuan Huang commented on HDDS-15124:
----------------------------------------
I'm interested in fixing this. I'll open a PR with the URL updates shortly.
> [Docs] Fix broken in-repo doc links
> -----------------------------------
>
> Key: HDDS-15124
> URL: https://issues.apache.org/jira/browse/HDDS-15124
> Project: Apache Ozone
> Issue Type: Task
> Components: documentation
> Reporter: Chi-Hsuan Huang
> Priority: Minor
>
> Following the migration of ozone.apache.org from Hugo to Docusaurus (in
> apache/ozone-site), several files in this repo still reference URLs that no
> longer resolve.
>
> The migration:
> - dropped the /docs/current/ and /docs/edge/ namespaces (latest now at
> /docs/, archives at /docs/2.0.0/ and /docs/1.4.1/)
> - dropped the .html ugly-URL suffix
> - reorganized content (e.g. Getting Started -> Quick Start; install methods
> nested under /quick-start/installation/)
> h3. Scope (current state of master)
> 17 occurrences across 11 files:
> - 4x /docs/current/_.html pattern (mostly hadoop-ozone/dist/README.md)
> - 13x /docs/edge/_.html pattern (mostly hadoop-hdds/docs/content/
> - Plus README.md, CONTRIBUTING.md
> h3. Relationship to HDDS-14663
> That ticket's PR ([https://github.com/apache/ozone-site/pull/351]) restores
> /docs/edge/ as a static archive on the site side, which would un-break the
> /edge/ references but does not cover /docs/current/ and bakes the
> pre-migration URL structure into the site permanently. This ticket takes the
> alternative approach: update repo links to current Docusaurus paths so the
> codebase tracks the live site structure.
> h3. Proposed fix
> Single PR rewriting all 17 URLs to their current Docusaurus equivalents.
> h3. Possible follow-up
> Add a link-checker step to CI (e.g. inside
> hadoop-ozone/dev-support/checks/docs.sh) that crawls markdown for
> ozone.apache.org/docs/... references and fails on 404. Out of scope for this
> ticket.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
