docs: rename nvidia.defaultMem to nvidia.defaultMemory in configure docs#451
Open
zzzkl wants to merge 1 commit into
Open
docs: rename nvidia.defaultMem to nvidia.defaultMemory in configure docs#451zzzkl wants to merge 1 commit into
zzzkl wants to merge 1 commit into
Conversation
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: zzzkl The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Contributor
|
Welcome @zzzkl! It looks like this is your first PR to Project-HAMi/website 🎉 |
zzzkl
force-pushed
the
fix/configure-defaultmem-rename
branch
2 times, most recently
from
e707582 to
93b1e42
Compare
The ConfigMap field is named 'defaultMemory' (struct tag yaml:"defaultMemory"), not 'defaultMem'. 'defaultMem' was the legacy CLI flag name (--default-mem), which has since been removed. Update the configure docs (current + v2.8.0, EN + ZH) to match the actual configuration key. Signed-off-by: zzzkl <zhaokailin@gmail.com>
zzzkl
force-pushed
the
fix/configure-defaultmem-rename
branch
from
93b1e42 to
f79bca6
Compare
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
1 participant
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 this PR does
The device configuration table in the user guide lists the default memory option as
nvidia.defaultMem, but the actual ConfigMap field isdefaultMemory(Go struct tagyaml:"defaultMemory"inpkg/device/nvidia/device.go).defaultMemwas the name of the original CLI flag (--default-mem, default5000), introduced back in 2021. That flag was later superseded by the ConfigMap-baseddefaultMemoryfield and has since been removed from the scheduler. The docs were never updated, so users following them set a key that has no effect.This PR renames
nvidia.defaultMem->nvidia.defaultMemoryin:docs/userguide/configure.md(current, EN)i18n/zh/docusaurus-plugin-content-docs/current/userguide/configure.md(current, ZH)versioned_docs/version-v2.8.0/userguide/configure.md(v2.8.0, EN)i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/userguide/configure.md(v2.8.0, ZH)Older versioned snapshots are intentionally left untouched.
AI assistance disclosure
This change was prepared with AI assistance (Claude Code).