docs: Fix broken links in documentation cloud and edge components.#765
docs: Fix broken links in documentation cloud and edge components.#765Sarvagya035 wants to merge 4 commits intokubeedge:masterfrom
Conversation
Signed-off-by: Sarvagya <sarvagya035@gmail.com>
|
Welcome @Sarvagya035! It looks like this is your first PR to kubeedge/website 🎉 |
Summary of ChangesHello @Sarvagya035, 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 enhancing the quality and user experience of the KubeEdge documentation. It resolves issues with outdated and broken links in key architectural components like CloudHub and EdgeHub, preventing users from encountering non-existent pages. Additionally, it improves the readability of the Edge Controller documentation by rectifying bullet list formatting, making the content more presentable and easier to consume. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
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/S
![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
Thank you for fixing the broken links in the documentation. The changes correctly update the URLs to the moved quic-design.md file. For improved maintainability and to ensure links work across different environments (like forks or local previews), I've suggested using relative paths for links to files within the repository instead of absolute GitHub URLs.
docs/architecture/cloud/cloudhub.md
Outdated
| - **Start the websocket server only**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#start-the-websocket-server-only) to see the details. | ||
| - **Start the quic server only**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#start-the-quic-server-only) to see the details. | ||
| - **Start the websocket and quic server at the same time**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#start-the-websocket-and-quic-server-at-the-same-time) to see the details |
There was a problem hiding this comment.
For better maintainability and to ensure links work correctly in forks and different hosting environments, it's recommended to use relative paths for links to files within the same repository. Using relative paths makes the documentation more portable.
| - **Start the websocket server only**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#start-the-websocket-server-only) to see the details. | |
| - **Start the quic server only**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#start-the-quic-server-only) to see the details. | |
| - **Start the websocket and quic server at the same time**: Click [here](https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md#start-the-websocket-and-quic-server-at-the-same-time) to see the details | |
| - **Start the websocket server only**: Click [here](../../proposals/sig-architecture/quic-design.md#start-the-websocket-server-only) to see the details. | |
| - **Start the quic server only**: Click [here](../../proposals/sig-architecture/quic-design.md#start-the-quic-server-only) to see the details. | |
| - **Start the websocket and quic server at the same time**: Click [here](../../proposals/sig-architecture/quic-design.md#start-the-websocket-and-quic-server-at-the-same-time) to see the details |
There was a problem hiding this comment.
this is the problem that docs already has, not related to this PR. so i would say this is not requirement to address with this PR, but in general relative path would be better solution for the portability.
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.
For better maintainability, it's recommended to use relative paths for links to files within the same repository instead of absolute GitHub URLs. This makes the links more robust and portable.
| - **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**: Click [here](../../proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-websocket-protocol) for details. | |
| - **Through QUIC protocol**: Click [here](../../proposals/sig-architecture/quic-design.md#edgehub-connect-to-cloudhub-through-quic) for details. |
Signed-off-by: Sarvagya <sarvagya035@gmail.com>
kubeedge-bot
added
size/M
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
good eye, thanks for the fix 👍
|
Hii @fujitatomoya Thanks for the feedback! I agree that using relative paths would improve portability. I’ll make the suggested changes in this PR. |
Signed-off-by: Sarvagya <sarvagya035@gmail.com>
kubeedge-bot
added
size/L
|
Hii @fujitatomoya |
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
lgtm with green CI.
|
[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 |
|
/assign @fisherxu |
4 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, ...)
Docs Update
This PR fixes incorrect links in the following documentation sections:
Additionally it fixes incorrect formatting of bullet points in the Edge Controller#upstream-controller and Edge Controller#controller-manager sections of the docs
What is the current behavior? (You can also link to an open issue here)
Incorrect links in the EdgeHub#usage and CloudHub#usage section of the docs direct readers to pages which no longer exist
Bullet point formatting in the Edge Controller#upstream-controller and Edge Controller#controller-manager sections of the docs is not applied properly:
What is the new behavior (if this is a feature change)?
I have updated the broken links in the EdgeHub and CloudHub documents so that they points to the correct documentation.
https://github.com/kubeedge/kubeedge/blob/master/docs/proposals/sig-architecture/quic-design.md
Additionally, I’ve improved the Edge Controller documentation by fixing the bullet list formatting as shown in the screenshots below.
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Other information: