docs: fix small typos and mislabeled link text#217
Open
mesutoezdil wants to merge 1 commit intoProject-HAMi:masterfrom
Open
docs: fix small typos and mislabeled link text#217mesutoezdil wants to merge 1 commit intoProject-HAMi:masterfrom
mesutoezdil wants to merge 1 commit intoProject-HAMi:masterfrom
Conversation
While auditing the docs tree, a handful of small prose issues turned up:
- volcano-vgpu monitor metrics table had 'vertain_pod' in a metric name
(the actual Prometheus metric exposed by volcano is
'vgpu_device_core_allocation_for_a_certain_pod')
- vastai sharing intro had a subject/verb agreement slip
('... devices and provides ...' with subject 'We')
- contributor/adopters.md: the link text 'HAMi-io/website' referred to
a non-existent org while the URL correctly pointed at Project-HAMi;
also an unintended capital in the sample table sentence
- vastai default-use example contained a non-breaking hyphen (U+2011)
in 'long-running' which breaks copy/paste and search
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: mesutoezdil 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 |
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
Summary
A handful of small prose-level issues surfaced while reading through the docs. None of these are style preferences: each one is an objective fix:
docs/userguide/volcano-vgpu/nvidia-gpu/monitor.md: the metrics table listedvolcano_vgpu_device_core_allocation_for_a_vertain_pod. The actual metric name in volcano's source is..._for_a_certain_pod(seepkg/scheduler/api/devices/nvidia/vgpu/metrics.goin volcano-sh/volcano), so the docs were misleading.docs/userguide/vastai/enable-vastai-sharing.md: subject/verb slip: "We now support sharing ... devices and provides the following capabilities" →provide(subject is "We").docs/contributor/adopters.md: two link markdowns showed[HAMi-io/website]as display text while the URL correctly pointed tohttps://github.com/Project-HAMi/website.HAMi-iois not the org name; aligned display text with the actual repo. Also lowercased an accidental capital in the sample table ("to Manage" → "to manage").docs/userguide/vastai/examples/default-use.md: "long‑running" used a non-breaking hyphen (U+2011) instead of an ASCII hyphen; replaced with regular-so the word remains searchable and copy-pastes cleanly.