update broken documentation links in CONTRIBUTING.md#1480
update broken documentation links in CONTRIBUTING.md#1480kmesh-bot merged 14 commits intokmesh-net:mainfrom
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @AkarshSahlot, 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 addresses and resolves issues with broken documentation links within the CONTRIBUTING.md file. The primary goal is to ensure that contributors have access to accurate and functional links for essential development tasks such as compiling the project and running various tests. By updating these URLs, the PR improves the overall contributor experience and streamlines the onboarding process for new developers.
Highlights
- Documentation Link Update: The link for "Compile and Build Kmesh" was updated from
https://kmesh.net/en/docs/developer/build-guide/tohttps://kmesh.net/docs/setup/develop-with-kind/. - Documentation Link Update: The link for "Run Unit Test" was updated from
https://kmesh.net/en/docs/developer/run-ut/tohttps://kmesh.net/docs/developer-guide/tests/unit-test/. - Documentation Link Update: The link for "Run E2E Test" was updated from
https://kmesh.net/en/docs/developer/e2e-guide/tohttps://kmesh.net/docs/developer-guide/tests/e2e-test/.
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. 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.
Broken links now fixed,A clear path for all to see,Code flows smooth and free.
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. ↩
There was a problem hiding this comment.
Code Review
This pull request fixes several broken documentation links in CONTRIBUTING.md. While the links now resolve, the new destinations for the unit test and E2E test guides appear to be proposal documents rather than final guides. This could cause confusion for contributors. I've added a comment with suggestions to link to more definitive documentation.
| - To run unit test, refer to [Run Unit Test](https://kmesh.net/docs/developer-guide/tests/unit-test/) | ||
| - To run e2e test, refer to [Run E2E Test](https://kmesh.net/docs/developer-guide/tests/e2e-test/) |
There was a problem hiding this comment.
The new links for running unit and E2E tests appear to point to documentation that is still in a proposal stage, which may confuse contributors looking for stable instructions.
- The unit test document (
docs/proposal/ebpf_unit_test.md) is a design proposal and lacks concrete commands for running tests. - The E2E test document (
docs/proposal/e2e.md) refers back to the old, broken "official doc" link this PR aims to fix, creating a confusing circular reference.
To improve the contributor experience, please consider linking to definitive guides. If these proposals are now the official documentation, they should ideally be moved out of the proposal directory and updated to remove outdated references.
|
It seems that the first link should be modified to https://kmesh.net/docs/developer-guide/build-guide? |
You're absolutely right! Sorry for the typo - I've fixed the link to https://kmesh.net/docs/developer-guide/build-guide. Thank you for catching that! |
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
Signed-off-by: Yash Israni <yashisrani52@gmail.com> Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
## Summary Fixes broken documentation links in the Creating Pull Requests section of CONTRIBUTING.md that were returning "Page Not Found" errors. ## Changes - Updated "Compile and Build Kmesh" link to point to https://kmesh.net/docs/setup/develop-with-kind/ - Updated "Run Unit Test" link to point to https://kmesh.net/docs/developer-guide/tests/unit-test/ - Updated "Run E2E Test" link to point to https://kmesh.net/docs/developer-guide/tests/e2e-test/ ## Testing - Verified all three links now resolve correctly - Confirmed markdown syntax renders properly in GitHub preview - All links lead to the appropriate documentation pages Fixes kmesh-net#1477 Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
|
Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages. The list of commits with invalid commit messages:
DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hzxuzhonghu The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Hi @hzxuzhonghu, |
Summary
Fixes broken documentation links in the Creating Pull Requests section of CONTRIBUTING.md that were returning "Page Not Found" errors.
Changes
Testing
Fixes #1477