Commit 193c7e4
authored
Fix broken documentation URLs in CLI commands (#14651)
## 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: #14652
Signed-off-by: Beza <[email protected]>1 parent 9bb223c commit 193c7e4
File tree
4 files changed
+5
-5
lines changed- charts/linkerd-control-plane
- cli/cmd
- multicluster/cmd
4 files changed
+5
-5
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
120 | 120 | | |
121 | 121 | | |
122 | 122 | | |
123 | | - | |
| 123 | + | |
124 | 124 | | |
125 | | - | |
| 125 | + | |
126 | 126 | | |
127 | 127 | | |
128 | 128 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
80 | | - | |
| 80 | + | |
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
78 | | - | |
| 78 | + | |
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
88 | 88 | | |
89 | 89 | | |
90 | 90 | | |
91 | | - | |
| 91 | + | |
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
| |||
0 commit comments