Skip to content

Commit 193c7e4

Browse files
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

4 files changed

+5
-5
lines changed

charts/linkerd-control-plane/README.md.gotmpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ extensions. Check the corresponding docs for each one of the following
120120
extensions:
121121

122122
* Observability:
123-
[Linkerd-viz](https://github.com/linkerd/linkerd2/blob/main/viz/charts/linkerd-viz/README.md)
123+
[Linkerd-viz](https://github.com/linkerd/linkerd2/blob/main/viz/charts/linkerd-viz/values.yaml)
124124
* Multicluster:
125-
[Linkerd-multicluster](https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster/README.md)
125+
[Linkerd-multicluster](https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster/values.yaml)
126126

127127
{{ template "chart.requirementsSection" . }}
128128

cli/cmd/upgrade.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ plane. The default values displayed in the Flags section below only apply to the
7777
install command.
7878
7979
The upgrade can be configured by using the --set, --values, --set-string and --set-file flags.
80-
A full list of configurable values can be found at https://www.github.com/linkerd/linkerd2/tree/main/charts/linkerd2/README.md
80+
A full list of configurable values can be found at https://www.github.com/linkerd/linkerd2/tree/main/charts/linkerd-control-plane/values.yaml
8181
`,
8282

8383
Example: ` # Upgrade CRDs first

multicluster/cmd/install.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ func newMulticlusterInstallCommand() *cobra.Command {
7575
linkerd multicluster install | kubectl apply -f -
7676
7777
The installation can be configured by using the --set, --values, --set-string and --set-file flags.
78-
A full list of configurable values can be found at https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster/README.md
78+
A full list of configurable values can be found at https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster/values.yaml
7979
`,
8080
RunE: func(cmd *cobra.Command, _ []string) error {
8181
if !ignoreCluster {

multicluster/cmd/link.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ each cluster and applied to the other.`,
8888
linkerd --context=east multicluster link --cluster-name east | kubectl --context=west apply -f -
8989
9090
The command can be configured by using the --set, --values, --set-string and --set-file flags.
91-
A full list of configurable values can be found at https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster-link/README.md
91+
A full list of configurable values can be found at https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster-link/values.yaml
9292
`,
9393
RunE: func(cmd *cobra.Command, args []string) error {
9494

0 commit comments

Comments
 (0)