linkerd / linkerd/website

Majority of the doc pages are too focussed on the `linkerd inject` command

Open
#520 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
60
Forks
221
Avg merge
4h 32m
Merged PRs (30d)
1

Description

I don’t like that most of the docs only refer to the `linkerd inject` command.

Example: https://linkerd.io/2/features/protocol-detection/

We use Helm for all our deployments so I don’t want to use linkerd inject. What I’d really like to see in the documentation is the actual change that’s required in the yaml file with a side not that it can also be done via linkerd inject.

I feel like you’d trying to hide the details in an attempt to make it easier for people. In reality anyone that’s working with these tools will still need to be able to read and understand a k8s .yaml file. Hiding these details actually just makes Linkerd harder to use and debug.

Contributor guide

Open the contributing guide

Research direction

Start with the protocol-detection documentation page linked in the issue and review other pages that primarily describe `linkerd inject`. Update the relevant deployment guidance to show the required Kubernetes YAML change, while noting `linkerd inject` as an alternative. Done means Helm users can follow the YAML-based instructions across the affected pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.