[no-relnote] Fix typos in docs #1231
Conversation
Signed-off-by: omahs <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR fixes typos in documentation files, ensuring clarity in both the MIG strategy section of the README and the release process instructions in RELEASE.md.
- Corrects grammatical errors in the MIG device type description.
- Removes an extraneous word in the helm note.
- Fixes phrasing in the changelog generation and release instructions.
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 | Fixed typos in device type description and helm note. |
| RELEASE.md | Corrected wording in changelog instructions and release steps. |
| @@ -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: | |||
There was a problem hiding this comment.
Corrected typo: replaced 'defines' with 'defined' for proper grammar.
Copilot uses AI. Check for mistakes.
| @@ -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 | |||
There was a problem hiding this comment.
Fixed redundant wording by removing the extra 'the'.
| 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.
| @@ -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. | |||
There was a problem hiding this comment.
Corrected typo by removing the redundant article 'a'.
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. |
There was a problem hiding this comment.
Removed duplicate 'the' for clearer wording.
Copilot uses AI. Check for mistakes.
Fix typos in docs