bug(quick-start): fix kubectl logs verification commands#300
Conversation
Signed-off-by: Shubh Pingale <135618936+shubhtrek@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the quick-start documentation by improving the kubectl logs verification commands, adding a recommended label-based approach and fixing a JSONPath expression for single pod logs. Feedback was provided to ensure these documentation changes are synchronized with the Chinese translation file to maintain consistency.
| # Option 1: Get logs from all Kmesh pods (recommended) | ||
| kubectl logs -n kmesh-system -l app=kmesh | ||
|
|
||
| # Option 2: Get logs from the first pod | ||
| kubectl logs -n kmesh-system $(kubectl get pods -n kmesh-system -o jsonpath='{.items[0].metadata.name}') | ||
| ``` |
There was a problem hiding this comment.
The improvements to the kubectl logs verification commands should also be synchronized with the Chinese translation to maintain consistency across the documentation. The file i18n/zh/docusaurus-plugin-content-docs/current/setup/quick-start.md (around line 151) still contains the broken jsonpath expression and lacks the new recommended label-based command.
Suggested translations for the new comments:
# Option 1: Get logs from all Kmesh pods (recommended)-># 选项 1：获取所有 Kmesh pod 的日志（推荐）# Option 2: Get logs from the first pod-># 选项 2：获取第一个 pod 的日志
There was a problem hiding this comment.
Pull request overview
Fixes the Quick Start verification logs commands by correcting the jsonpath expression and adding a recommended label-selector-based kubectl logs option, aligning the docs with the intended Kmesh verification flow (Issue #297).
Changes:
- Add a recommended command to fetch logs from all Kmesh pods via
-l app=kmesh. - Fix the broken
jsonpathexpression to correctly select the first pod name (.items[0].metadata.name).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Option 2: Get logs from the first pod | ||
| kubectl logs -n kmesh-system $(kubectl get pods -n kmesh-system -o jsonpath='{.items[0].metadata.name}') |
Summary
Fix broken jsonpath expression in the Kmesh verification logs command.
Changes
Before
kubectl logs -n kmesh-system $(kubectl get pods -n kmesh-system -o jsonpath='{.items.metadata.name}')After
#297