Fix typos and update stale documentation links#2059
Merged
Conversation
EoinTrial
force-pushed
the
fix/typos-and-stale-links
branch
from
3cecaa3 to
9f0b305
Compare
EoinTrial
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes documentation by correcting small wording issues and updating external links that have become stale, keeping the docs accurate and navigable.
Changes:
- Fixes multiple typos/wording issues across plugin and templating docs.
- Updates the VMware Tanzu Kubernetes Grid (TKG) documentation link to the Broadcom techdocs domain.
- Updates the Azure Container Registry documentation link to the learn.microsoft.com domain.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/topics/registries.mdx | Updates Azure Container Registry external documentation link. |
| docs/topics/plugins.mdx | Fixes a typo in the platformHooks vs hooks description. |
| docs/topics/kubernetes_distros.md | Updates TKG external documentation link. |
| docs/plugins/user/index.md | Fixes “build-in” → “built-in”. |
| docs/plugins/overview.md | Fixes “build-in” → “built-in”. |
| docs/chart_template_guide/functions_and_pipelines.mdx | Fixes “useable” → “usable”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
EoinTrial
force-pushed
the
fix/typos-and-stale-links
branch
from
9f0b305 to
4e26e53
Compare
EoinTrial
changed the title
EoinTrial
changed the title
Contributor
|
Commit needs --signoff. If you use the cli, probably something like |
Signed-off-by: Eoin Shaughnessy <eoinsh@gmail.com>
EoinTrial
force-pushed
the
fix/typos-and-stale-links
branch
from
4e26e53 to
12e1514
Compare
Contributor
Author
|
@TerryHowe Thanks for sharing that! Have signed off. |
Contributor
Author
|
@TerryHowe May I get another review, please? :) |
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
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.
Fix four typos and update two stale links across six documentation files.
Typos:
docs/plugins/overview.md: "build-in" → "built-in"docs/plugins/user/index.md: "build-in" → "built-in"docs/chart_template_guide/functions_and_pipelines.mdx: "useable" → "usable"docs/topics/plugins.mdx: "resultin" → "result in"Stale links:
docs/topics/kubernetes_distros.md: TKG documentation link was pinned to version 1.6 and pointed to the olddocs.vmware.comdomain. Updated to the current TKG documentation ontechdocs.broadcom.comfollowing Broadcom's acquisition of VMware. Also corrected grammatically incomplete sentence and updated link text to match the target page.docs/topics/registries.mdx: Azure Container Registry docs link updated fromdocs.microsoft.comtolearn.microsoft.com, with the original#push-chart-to-registry-as-oci-artifactanchor preserved.