Skip to content

Broken documentation URLs in CLI help commands return 404 errors #14652

@bezarsnba

Description

@bezarsnba

What is the issue?

Problem

Several CLI commands in Linkerd2 contain references to documentation URLs that return 404 errors. The URLs are pointing to README.md files that don't exist in the chart directories, creating a poor user experience when developers try to access configuration documentation.

Affected URLs:

  • linkerd upgrade --help: References https://www.github.com/linkerd/linkerd2/tree/main/charts/linkerd2/README.md (404)
  • linkerd multicluster install --help: References https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster/README.md (404)
  • linkerd multicluster link --help: References https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster-link/README.md (404)
  • Chart documentation template also references non-existent README files

Expected Solution

Update all CLI help text and documentation to point to the correct values.yaml files instead of non-existent README.md files. The values.yaml files contain the actual configurable values that users need.

Impact

This affects user experience as developers cannot easily access configuration documentation when using CLI help commands.

How can it be reproduced?

linkerd mc link  --help
Outputs resources that allow another cluster to mirror services from this one.

Note that the Link resource applies only in one direction. In order for two
clusters to mirror each other, a Link resource will have to be generated for
each cluster and applied to the other.

Usage:
  linkerd multicluster link [flags]

Examples:
  # To link the west cluster to east
  linkerd --context=east multicluster link --cluster-name east | kubectl --context=west apply -f -

The command can be configured by using the --set, --values, --set-string and --set-file flags.
A full list of configurable values can be found at https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster-link/README.md

Logs, error output, etc

The command can be configured by using the --set, --values, --set-string and --set-file flags.
A full list of configurable values can be found at https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster-link/README.md

output of linkerd check -o short

linkerd-version
---------------
‼ cli is up-to-date
    is running version 24.11.8 but the latest edge version is 25.10.5
    see https://linkerd.io/2/checks/#l5d-version-cli for hints

control-plane-version
---------------------
‼ control plane is up-to-date
    is running version 24.11.8 but the latest edge version is 25.10.5
    see https://linkerd.io/2/checks/#l5d-version-control for hints


Environment

  • Linkerd version: 24.11.8

Possible solution

No response

Additional context

No response

Would you like to work on fixing this bug?

None

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions