Update install-with-keadm.md for KubeEdge v1.21#732
Update install-with-keadm.md for KubeEdge v1.21#732sachin21212121 wants to merge 3 commits intokubeedge:masterfrom
Conversation
…links and metrics-server YAML 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 a comprehensive update to the 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 provides a significant improvement to the install-with-keadm.md documentation by updating it for KubeEdge v1.21 and refactoring it for better clarity and conciseness. The new structure is much easier to follow. I've identified a few critical issues, including incorrect command syntax within code blocks and a broken link, which will prevent users from successfully following the instructions. After addressing these points, the documentation will be in great shape.
docs/setup/install-with-keadm.md
Outdated
| docker run --rm kubeedge/installation-package:v1.17.0 cat /usr/local/bin/keadm > /usr/local/bin/keadm && chmod +x /usr/local/bin/keadm | ||
| ``` | ||
| ```bash | ||
| wget [https://github.com/kubeedge/kubeedge/releases/download/v1.21.0/keadm-v1.21.0-linux-amd64.tar.gz](https://github.com/kubeedge/kubeedge/releases/download/v1.21.0/keadm-v1.21.0-linux-amd64.tar.gz) |
There was a problem hiding this comment.
The wget command in this code block includes Markdown link syntax [text](url), which is not valid for a shell command. This will cause the command to fail if a user copies and pastes it. The URL should be passed directly to wget.
| wget [https://github.com/kubeedge/kubeedge/releases/download/v1.21.0/keadm-v1.21.0-linux-amd64.tar.gz](https://github.com/kubeedge/kubeedge/releases/download/v1.21.0/keadm-v1.21.0-linux-amd64.tar.gz) | |
| wget https://github.com/kubeedge/kubeedge/releases/download/v1.21.0/keadm-v1.21.0-linux-amd64.tar.gz |
docs/setup/install-with-keadm.md
Outdated
| # keadm gettoken | ||
| 27a37ef16159f7d3be8fae95d588b79b3adaaf92727b72659eb89758c66ffda2.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTAyMTYwNzd9.JBj8LLYWXwbbvHKffJBpPd5CyxqapRQYDIXtFZErgYE | ||
| ``` | ||
| Refer to [Enable Kubectl logs/exec documentation](https://www.google.com/search?q=../advanced/debug.md). |
There was a problem hiding this comment.
The link for "Enable Kubectl logs/exec documentation" incorrectly points to a Google search query. This link should point to the actual documentation page to be useful for the user. The previous relative link ../advanced/debug.md was correct and would be resolved by the documentation generator.
| Refer to [Enable Kubectl logs/exec documentation](https://www.google.com/search?q=../advanced/debug.md). | |
| Refer to [Enable Kubectl logs/exec documentation](../advanced/debug.md). |
docs/setup/install-with-keadm.md
Outdated
| ```shell | ||
| keadm join --cloudcore-ipport="THE-EXPOSED-IP":10000 --token=27a37ef16159f7d3be8fae95d588b79b3adaaf92727b72659eb89758c66ffda2.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTAyMTYwNzd9.JBj8LLYWXwbbvHKffJBpPd5CyxqapRQYDIXtFZErgYE --kubeedge-version=v1.12.1 | ||
| ```bash | ||
| git clone [https://github.com/kubernetes-sigs/metrics-server.git](https://github.com/kubernetes-sigs/metrics-server.git) |
There was a problem hiding this comment.
The git clone command in this code block includes Markdown link syntax [text](url), which is invalid in a shell command. This will cause the command to fail if copied and pasted. The repository URL should be provided directly to the git clone command.
| git clone [https://github.com/kubernetes-sigs/metrics-server.git](https://github.com/kubernetes-sigs/metrics-server.git) | |
| git clone https://github.com/kubernetes-sigs/metrics-server.git |
docs/setup/install-with-keadm.md
Outdated
| ``` | ||
| ``` |
There was a problem hiding this comment.
There is an empty code block at the end of the file. This appears to be a leftover from editing and should be removed to improve the document's cleanliness.
…1.21 Signed-off-by: sachin21212121 <jhasachin0115@gmail.com>
2 participants
This PR updates the install-with-keadm.md documentation based on feedback from PR #725.
Changes include:
Updated instructions for KubeEdge v1.21.
Fixed all broken links.
Removed redundant content and excessive blank lines.
Corrected code block language formatting.
Added “Deprecated Commands” sections for clarity.
Simplified and clarified the introduction and prerequisites.