docs: update Troubleshooting guide for v1.21 with final cleanup#730
docs: update Troubleshooting guide for v1.21 with final cleanup#730sachin21212121 wants to merge 2 commits intokubeedge:masterfrom
Conversation
Signed-off-by: sachin21212121 <jhasachin0115@gmail.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 |
Summary of ChangesHello @sachin21212121, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on refining the KubeEdge Troubleshooting guide to align with version 1.21.0. The updates provide more accurate and user-friendly instructions for common issues such as Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
kubeedge-bot
added
the
size/L
![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 significantly improves the troubleshooting documentation by updating it for KubeEdge v1.21, reorganizing the content for better clarity, and enhancing the formatting. The guide is now much more user-friendly and informative. I have a couple of minor suggestions to fix some formatting issues in the markdown.
| │ ├── cluster_objectsync_v1alpha1.yaml | ||
| │ └── objectsync_v1alpha1.yaml | ||
| └── kubeedge-v1.21.0-linux-amd64.tar.gz | ||
| ```` |
There was a problem hiding this comment.
There's a typo in the closing fence of this code block. It uses four backticks (````) instead of the standard three (```). This should be corrected to ensure the markdown renders correctly across all platforms.
| ```` |
There was a problem hiding this comment.
this needs to be addressed.
| <!-- end list --> | ||
|
|
||
| You can also enable `kubectl logs` feature refer to this [guide](../advanced/debug.md). No newline at end of file | ||
| ``` | ||
| ``` |
There was a problem hiding this comment.
These trailing lines appear to be leftover artifacts and should be removed. The HTML comment <!-- end list --> serves no purpose here, and the empty code blocks will render as empty boxes, which is likely not intended. Removing them will provide a cleaner end to the document.
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
@sachin21212121 out of curiosity, did you try to build the doc site in local env?
| │ ├── cluster_objectsync_v1alpha1.yaml | ||
| │ └── objectsync_v1alpha1.yaml | ||
| └── kubeedge-v1.21.0-linux-amd64.tar.gz | ||
| ```` |
There was a problem hiding this comment.
this needs to be addressed.
| ``` | ||
| ``` |
There was a problem hiding this comment.
why do we even need this code block?
|
@sachin21212121 are you still working on this? |
yes, i was occupied with some work, but now i am happy to contribute further |
3 participants
Update KubeEdge Troubleshooting guide with fixes for keadm init, CRDs for v1.21.0, pod troubleshooting, logging instructions, and formatting improvements from #726 (#726).