[
https://issues.apache.org/jira/browse/YUNIKORN-3389?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
KAI-JAY TU updated YUNIKORN-3389:
---------------------------------
Description:
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
was:
While working on YUNIKORN-3248 (user guide update), three descriptions in the
design doc docs/design/quota_preemptor.md no longer match the current
implementation. This was acknowledged by @manirajv06 on
apache/yunikorn-site#570 as a follow-up item.
Reference: apache/yunikorn-site master 66ef06c, docs/design/quota_preemptor.md
*1) Timer behavior on config changes (around line 110)*
Design doc says:
{quote}In case of any such changes, timers reset and start again from the
beginning.{quote}
Implementation actually does:
* Delay change: delta adjustment, startTime += (newDelay - oldDelay).
* Consecutive quota decreases: preserves the earliest startTime instead of
resetting.
References: internalQuotaPreemption() in scheduler.go, quota_preemptor.go,
tryAcquirePreemption() in queue.go.
*2) Delay format and placement (lines 74, 94, 107)*
Design doc shows the delay as an integer in seconds under the resources: block,
for example:
{code:yaml}
resources:
max: {memory: 10G}
quota.preemption.delay: 7200
{code}
Implementation actually uses Go time.Duration format under queue properties:,
for example:
{code:yaml}
properties:
quota.preemption.delay: 2h
{code}
*3) Impact of Restart section (around lines 113-115)*
Design doc only says the timer "would start again from the beginning" after
restart. It does not explain that during recovery, IncAllocatedResource()
triggers setPreemptionTime() when usage > max, which effectively restarts the
countdown from the recovery moment.
*Acceptance criteria*
* docs/design/quota_preemptor.md updated so the three items above match the
current implementation.
* Sample YAML in the doc reflects properties: placement and time.Duration
format.
* Restart section explains the setPreemptionTime() trigger during recovery.
*Not in scope*
* User guide (already covered by YUNIKORN-3248 / apache/yunikorn-site#570).
* Implementation changes.
> 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, 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]
