[no-relnote] Fix typos in docs #1231
Conversation
Signed-off-by: omahs <[email protected]>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
This PR is stale because it has been open 90 days with no activity. This PR will be closed in 30 days unless new comments are made or the stale label is removed. |
github-actions
bot
added
the
lifecycle/stale
|
up |
github-actions
bot
removed
the
lifecycle/stale
There was a problem hiding this comment.
Pull Request Overview
This PR fixes several typos found in documentation files. The changes correct grammatical errors and improve readability in the GPU feature discovery documentation and release process checklist.
- Corrects grammatical errors in documentation text
- Fixes typos in the release process checklist
- Improves overall documentation quality
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/gpu-feature-discovery/README.md | Fixes two typos: "defines" to "defined" and removes extra "the" in a note |
| RELEASE.md | Corrects two typos: "the a draft" to "the draft" and removes duplicate "the" |
| 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: |
There was a problem hiding this comment.
Correct grammatical fix: changed 'defines' to 'defined' to match proper verb tense.
Copilot uses AI. Check for mistakes.
| **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 |
There was a problem hiding this comment.
Correct grammatical fix: removed redundant 'the' to improve sentence flow.
| 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.
| - [ ] 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. |
There was a problem hiding this comment.
Correct grammatical fix: changed 'the a draft' to 'the draft' to fix article usage.
Copilot uses AI. Check for mistakes.
| - [ ] 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. |
There was a problem hiding this comment.
Correct grammatical fix: removed duplicate 'the' to improve readability.
Copilot uses AI. Check for mistakes.
|
cc @chenopis PTAL |
3 participants
Fix typos in docs