Fix broken documentation URLs in CLI commands #14651
Merged
Conversation
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
Signed-off-by: Beza <[email protected]>
cratelyn
approved these changes
Nov 12, 2025
Contributor
Author
|
Hi @adleong and @cratelyn , I saw that this workflow failed: linkerd/linkerd2/actions/runs/19178511645 Do I need to do anything? |
Member
you're good to go! a test had flaked, and just needed to be run once again. this is now merged! thank you again for opening this pull request, and for your patience, @bezarsnba. |
GTRekter
pushed a commit
to GTRekter/linkerd2
that referenced
this pull request
Dec 18, 2025
## Problem Several CLI commands contain documentation URLs that return 404 errors because they reference non-existent README.md files in chart directories. This creates a poor user experience when developers try to access configuration documentation through CLI help commands. The affected commands are: - linkerd upgrade: references charts/linkerd2/README.md - linkerd multicluster install: references linkerd-multicluster/README.md - linkerd multicluster link: references linkerd-multicluster-link/README.md - Chart documentation template also references broken README links ## Solution Updated all affected CLI help text and chart documentation to point directly to the corresponding values.yaml files, which contain the actual configurable values that users need. Changes made: - Fixed URL in cli/cmd/upgrade.go from charts/linkerd2/README.md to charts/linkerd-control-plane/values.yaml - Fixed URL in multicluster/cmd/install.go from linkerd-multicluster/README.md to linkerd-multicluster/values.yaml - Fixed URL in multicluster/cmd/link.go from linkerd-multicluster-link/README.md to linkerd-multicluster-link/values.yaml - Updated chart template in charts/linkerd-control-plane/README.md.gotmpl to reference values.yaml files Validation Manually tested the following commands to verify help text shows correct URLs: - linkerd upgrade --help - linkerd multicluster install --help - linkerd multicluster link --help Verified that all updated URLs now point to existing files containing configuration documentation. Fix: linkerd#14652 Signed-off-by: Beza <[email protected]> Signed-off-by: Ivan Porta <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem
Several CLI commands contain documentation URLs that return 404 errors because they reference non-existent README.md files in chart directories. This creates a poor user experience when developers try to access
configuration documentation through CLI help commands.
The affected commands are:
Solution
Updated all affected CLI help text and chart documentation to point
directly to the corresponding values.yaml files, which contain the
actual configurable values that users need.
Changes made:
charts/linkerd-control-plane/values.yaml
to linkerd-multicluster/values.yaml
to linkerd-multicluster-link/values.yaml
to reference values.yaml files
Validation
Manually tested the following commands to verify help text shows correct URLs:
Verified that all updated URLs now point to existing files containing
configuration documentation.
Fix: #14652