Update Broken Links in EdgeHub Docs + Fix Bullet Points Formatting in Edge Controller Docs#713
Update Broken Links in EdgeHub Docs + Fix Bullet Points Formatting in Edge Controller Docs#713eysk-io wants to merge 3 commits intokubeedge:masterfrom
Conversation
Signed-off-by: Eric Kim <erickim195@gmail.com>
Signed-off-by: Eric Kim <erickim195@gmail.com>
|
Welcome @eysk-io! It looks like this is your first PR to kubeedge/website 🎉 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @eysk-io, 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!
I've submitted this pull request to enhance the KubeEdge documentation by addressing two distinct issues. First, I've fixed broken links within the EdgeHub documentation that were leading users to non-existent pages. Second, I've corrected inconsistent bullet point formatting in the Edge Controller documentation to improve its visual presentation and readability. These changes collectively aim to provide a more accurate and user-friendly documentation experience.
Highlights
- Broken Link Fix in EdgeHub Docs: I've updated two broken links in the EdgeHub documentation (
docs/architecture/edge/edgehub.md). These links previously pointed to incorrecttree/masterpaths and were missing thesig-architecturedirectory, leading to 404 errors. The corrected links now accurately point to the relevant sections within thequic-design.mddocument. - Bullet Point Formatting Correction in Edge Controller Docs: I've resolved a formatting issue in the Edge Controller documentation (
docs/architecture/cloud/edge_controller.md) where bullet points were not rendering correctly due to inconsistent spacing. The changes ensure that all bullet points are properly aligned and displayed as intended, improving readability.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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 or fill out our survey to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
kubeedge-bot
added
the
size/M
There was a problem hiding this comment.
Code Review
This pull request successfully fixes broken links in the EdgeHub documentation and corrects list formatting in the Edge Controller documentation. My review provides suggestions to further improve the documentation's quality by ensuring consistent capitalization with Kubernetes and Go conventions, and by enhancing link accessibility with more descriptive text. These minor adjustments will improve the overall clarity and professionalism of the documentation.
docs/architecture/edge/edgehub.md
Outdated
| - **Through websocket protocol**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-websocket-protocol) for details. | ||
| - **Through QUIC protocol**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-quic) for details. |
There was a problem hiding this comment.
Using "Click here" for link text is not ideal for accessibility and readability. It's better to use descriptive text that informs the user about the link's destination.
| - **Through websocket protocol**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-websocket-protocol) for details. | |
| - **Through QUIC protocol**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-quic) for details. | |
| - **Through websocket protocol**: [Details on connecting via websocket protocol](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-websocket-protocol). | |
| - **Through QUIC protocol**: [Details on connecting via QUIC protocol](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-quic). |
There was a problem hiding this comment.
Adjusted the bullet points to below:
docs/architecture/edge/edgehub.md
Outdated
| - **Through websocket protocol**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-websocket-protocol) for details. | ||
| - **Through QUIC protocol**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-quic) for details. |
There was a problem hiding this comment.
I'm unsure about the nature of these docs, but if folks are sure the contents won't change while the directory in which these contents are might, im happy to replace these with github permanent links. i.e. the following:
- https://github.com/kubeedge/kubeedge/blob/23deff9549506bba137e9a150b040a3f37bc3e10/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-websocket-protocol
- https://github.com/kubeedge/kubeedge/blob/23deff9549506bba137e9a150b040a3f37bc3e10/docs/proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-quic
Then, these links won't return a 404 even if these files are moved in the future
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: fujitatomoya 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 |
Shelley-BaoYue
left a comment
Shelley-BaoYue
left a comment
There was a problem hiding this comment.
Please modify these suggestions proposed by CI robot. Like PodIp --> PodIP
kubeedge-bot
added
do-not-merge/invalid-commit-message
|
@Shelley-BaoYue @fujitatomoya tyvm for taking a look! Made some changes based on the gemini suggestions. lmk if i should make any more adjustments |
Signed-off-by: Eric Kim <erickim195@gmail.com>
kubeedge-bot
removed
the
do-not-merge/invalid-commit-message
|
/rebase |
|
@Shelley-BaoYue i think this is good to take. is there any way that we can rebase the PRs? e.g https://docs.mergify.com/workflow/rebase/ (that i usually use) |
|
@Shelley-BaoYue friendly ping. |
5 participants
Please check if the PR fulfills these requirements
Which issue(s) this PR fixes:
Fixes kubeedge/kubeedge#6427
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
This PR does two things:
What is the current behavior? (You can also link to an open issue here)
Incorrect links in the EdgeHub#usage section of the docs direct readers to pages which no longer exist, such as https://github.com/kubeedge/kubeedge/tree/master/docs/proposals/quic-design.md#edgehub-connect-to-cloudhub-through-websocket-protocol:
Formatting has not been applied to bullet points in the Edge Controller#upstream-controller and Edge Controller#controller-manager sections of the docs:
What is the new behavior (if this is a feature change)?
I've updated the broken links in the EdgeHub docs to point to the correct docs:
and also adjusted the Edge Controller docs such that the bullet points formatting is applied as expected as can be seen in the below images:
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Other information: