Skip to content

[no-relnote] Fix typos in docs #1231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[no-relnote] Fix typos in docs #1231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ The device plugin consists in two artifacts:
# Release Process Checklist:
- [ ] Create a release PR:
- [ ] Run the `./hack/prepare-release.sh` script to update the version in all the needed files. This also creates a [release issue](https://github.com/NVIDIA/cloud-native-team/issues?q=is%3Aissue+is%3Aopen+label%3Arelease)
- [ ] Run the `./hack/generate-changelog.sh` script to generate the a draft changelog and update `CHANGELOG.md` with the changes.
- [ ] Run the `./hack/generate-changelog.sh` script to generate the draft changelog and update `CHANGELOG.md` with the changes.
Copy link

Copilot AI Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected typo by removing the redundant article 'a'.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Aug 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct grammatical fix: changed 'the a draft' to 'the draft' to fix article usage.

Copilot uses AI. Check for mistakes.
- [ ] Create a PR from the created `bump-release-{{ .VERSION }}` branch.
- [ ] Merge the release PR
- [ ] Tag the release and push the tag to the `internal` mirror:
- [ ] Image release pipeline:
- [ ] Wait for the image release to complete.
- [ ] Push the tag to the the upstream GitHub repo.
- [ ] Push the tag to the upstream GitHub repo.
Copy link

Copilot AI Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed duplicate 'the' for clearer wording.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Aug 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct grammatical fix: removed duplicate 'the' to improve readability.

Copilot uses AI. Check for mistakes.
- [ ] Wait for the [`Release`](https://github.com/NVIDIA/k8s-device-plugin/actions/workflows/release.yaml) GitHub Action to complete
- [ ] Publish the [draft release](https://github.com/NVIDIA/k8s-device-plugin/releases) created by the GitHub Action
- [ ] Wait for the [`Publish Helm Chart`](https://github.com/NVIDIA/k8s-device-plugin/actions/workflows/helm.yaml) GitHub Action to complete
Expand Down
4 changes: 2 additions & 2 deletions docs/gpu-feature-discovery/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ is partitioned into 7 equal sized MIG devices (56 total).
### MIG 'mixed' strategy

With this strategy, a separate set of labels for each MIG device type is
generated. The name of each MIG device type is defines as follows:
generated. The name of each MIG device type is defined as follows:
Copy link

Copilot AI Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected typo: replaced 'defines' with 'defined' for proper grammar.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Aug 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct grammatical fix: changed 'defines' to 'defined' to match proper verb tense.

Copilot uses AI. Check for mistakes.

```
MIG_TYPE=mig-<slice_count>g.<memory_size>.gb
Expand Down Expand Up @@ -320,7 +320,7 @@ helm upgrade -i nvdp nvdp/nvidia-device-plugin \
--set devicePlugin.enabled=false
```

**Note:** You only need the to pass the `--devel` flag to `helm search repo`
**Note:** You only need to pass the `--devel` flag to `helm search repo`
and the `--version` flag to `helm upgrade -i` if this is a pre-release
Copy link

Copilot AI Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed redundant wording by removing the extra 'the'.

Suggested change
and the `--version` flag to `helm upgrade -i` if this is a pre-release
and `--version` flag to `helm upgrade -i` if this is a pre-release

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Aug 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct grammatical fix: removed redundant 'the' to improve sentence flow.

Suggested change
and the `--version` flag to `helm upgrade -i` if this is a pre-release
**Note:** You only need to pass `--devel` flag to `helm search repo`
and `--version` flag to `helm upgrade -i` if this is a pre-release

Copilot uses AI. Check for mistakes.
version (e.g. `<version>-rc.1`). Full releases will be listed without this.

Expand Down