docs: standardize CLI examples and correct linkerd-cni namespace references#2082
docs: standardize CLI examples and correct linkerd-cni namespace references#2082bezarsnba wants to merge 36 commits intolinkerd:mainfrom
Conversation
- Removes the '$' character from the beginning of commands in code blocks and terminal examples throughout the documentation. - Improves copy-paste usability and prevents errors when running commands. - Ensures consistency and follows documentation best practices for shell commands. Signed-off-by: Beza <bezarsnba@gmail.com>
Signed-off-by: Beza <bezarsnba@gmail.com>
Signed-off-by: Beza <bezarsnba@gmail.com>
linkerd.io/content/2-edge/tasks/multicluster-using-statefulsets.md
Outdated
Show resolved
Hide resolved
linkerd.io/content/2-edge/tasks/multicluster-using-statefulsets.md
Outdated
Show resolved
Hide resolved
|
@bezarsnba, y'know, I started reviewing this because I love the idea, but I realize that there's a complicating factor. Take a look at this example, from Contrast with this one, from The first example includes both the command and the output in the same block, so you can't copy & paste that as-is. The second example has no output, so you can. Overall, in places where we include the command and the output in the same block, it's important to have some way to distinguish what you should type from what you should see. The best answer here is likely to be to always use two separate blocks, which... that's a massive, massive change. (Even the second example should really be more like
So... I think this is going to need some work. Maybe a first PR fixing typos and such would be the quickest way forward while we figure out how to wrangle the bigger issue? Thanks for digging into this! |
Co-authored-by: Flynn <kflynn@users.noreply.github.com>
Co-authored-by: Flynn <kflynn@users.noreply.github.com>
…s.md Co-authored-by: Flynn <kflynn@users.noreply.github.com>
|
@kflynn , I agree that when a code block mixes command + output, removing prompts can make it harder to distinguish what should be executed versus what is expected output. Ideally, these should indeed be split into separate blocks. That said, I realized this PR started to grow in scope more than intended. To keep it reviewable and focused, I'll limit this PR to cases where the block contains command-only examples, keeping them prompt-free and copy/paste-friendly. For blocks that include output (or mixed content), I’ll leave them as-is for now and handle standardization separately (either in a follow-up PR or by opening an issue to define a clear convention). I'll also fix the stray / and minor formatting issues you pointed out. Thanks again for calling this out. :) |
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Co-authored-by: Flynn <kflynn@users.noreply.github.com>
Co-authored-by: Flynn <kflynn@users.noreply.github.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
linkerd.io/content/2.13/tasks/multicluster-using-statefulsets.md
Outdated
Show resolved
Hide resolved
| # clone example repository | ||
| $ git clone git@github.com:linkerd/l2d-k3d-statefulset.git | ||
| $ cd l2d-k3d-statefulset | ||
| git clone git@github.com:linkerd/l2d-k3d-statefulset.git |
There was a problem hiding this comment.
This block contains command-only examples; both commands can be executed sequentially.
|
|
||
| ```bash | ||
| ❯ kubectl -n linkerd-viz get deploy,cm | grep prometheus | ||
| $ kubectl -n linkerd-viz get deploy,cm | grep prometheus |
There was a problem hiding this comment.
Replaced the ❯ prompt with $ to keep shell examples consistent across the docs.
|
|
||
| ```bash | ||
| helm repo update | ||
| helm repo up |
There was a problem hiding this comment.
Updated helm repo update to helm repo up for consistency with other upgrade docs.
A broader cleanup to standardize on the official helm repo update command can be done separately.
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
|
@kflynn I’ve reviewed the points raised and updated the PR accordingly. I added comments in places that may need a bit more attention or context, based on the feedback provided. One note on the size of this PR: some of the changes were applied in bulk, which ended up making the PR larger than ideal. In hindsight, I agree this isn’t the best approach for documentation updates. For future work, I plan to break similar changes down into smaller, more focused PRs (for example, by section or by type of code block) to make reviews easier. Thanks again for the feedback and patience. :) |
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
Signed-off-by: bezarsnba <bezarsnba@gmail.com>
This PR improves documentation consistency and correctness across the Linkerd website docs.
It includes two related documentation-only changes:
These changes aim to reduce user confusion and improve copy/paste usability without altering any Linkerd behavior.
What changed
1. CLI command standardization
$,~ $,/ $) frombashandshcode blocksWhy this change
Scope
Validation