kmesh-net / kmesh-net/website

docs: broken jsonpath in quick-start.md "Verify Kmesh Service Logs" command

Open
#341 1 comment 0 reactions 1 assignee Claimed by @A-d-i-t-y View on GitHub
Dominant language
JavaScript
Stars
12
Forks
75
PR merge metrics
No merged PRs in 30d

Description

Problem:
In the Quick Start guide (docs/setup/quick-start.md), under "4. Verify Kmesh Service Logs", the command is:

kubectl logs -n kmesh-system $(kubectl get pods -n kmesh-system -o jsonpath='{.items.metadata.name}')

`.items` is a JSON array (kubectl get pods returns multiple pods), so `.items.metadata.name` is invalid jsonpath syntax without an index or wildcard. Running this command as written returns empty output or an error, so this step fails for anyone following the quick-start guide verbatim.

Expected fix:
Should be either:

kubectl logs -n kmesh-system $(kubectl get pods -n kmesh-system -o jsonpath='{.items[0].metadata.name}')

(for the first pod) or use a label selector to target the Kmesh pod specifically.

Additional context:
I'd like to work on this - happy to submit a PR with the fix.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.