[
https://issues.apache.org/jira/browse/YUNIKORN-3389?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
ASF GitHub Bot updated YUNIKORN-3389:
-------------------------------------
Labels: documentation pull-request-available website (was: documentation
website)
> Fix pre-existing broken anchors reported by pnpm build in versioned docs
> ------------------------------------------------------------------------
>
> Key: YUNIKORN-3389
> URL: https://issues.apache.org/jira/browse/YUNIKORN-3389
> Project: Apache YuniKorn
> Issue Type: Bug
> Components: documentation, website
> Affects Versions: 1.9.0
> Reporter: KAI-JAY TU
> Assignee: KAI-JAY TU
> Priority: Minor
> Labels: documentation, pull-request-available, website
>
> While working on YUNIKORN-3248 and YUNIKORN-3266, running {{pnpm build}} on
> apache/yunikorn-site produced a number of broken-anchor warnings coming from
> files under {{versioned_docs/}}. These warnings are pre-existing on master
> (they are not introduced by the current work) and add noise to every future
> docs PR.
> Reference: apache/yunikorn-site master 66ef06c
> h2. Goal
> * {{pnpm build}} on master completes without broken-anchor warnings/errors.
> * Only the minimum edits needed to make anchors resolve are made in
> {{versioned_docs/}} -- no content rewrites.
> h2. How to reproduce
> {code:bash}
> git clone https://github.com/apache/yunikorn-site.git
> cd yunikorn-site
> pnpm install
> pnpm build
> {code}
> Collect every warning/error of the form "Docusaurus found broken anchor" (or
> similar) and record which versioned doc file + anchor is affected.
> h2. Expected classes of fix
> * Broken *local* anchor: heading was renamed/removed in the same page ->
> update the link (or restore the heading anchor).
> * Broken *cross-page* anchor: link points to an anchor that no longer exists
> on the target page -> update the link target.
> * Stale anchor from a rename: update the caller to the new slug.
> h2. Acceptance criteria
> * {{pnpm build}} runs clean on master + this fix (no broken-anchor warnings
> or errors).
> * Changes are limited to {{versioned_docs/}} (and, if unavoidable, the
> matching current {{docs/}} anchor targets).
> * No content rewrites, style edits, or version bumps.
> h2. Not in scope
> * Design doc corrections (tracked in YUNIKORN-3388).
> * Deprecated user label doc cleanup (tracked in YUNIKORN-3344).
> * User guide rewrites (tracked in YUNIKORN-3248 / apache/yunikorn-site#570).
> Related:
> * YUNIKORN-3248
> * YUNIKORN-3266
> * YUNIKORN-3388
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
