[doc] trivial: Fix broken developer links #54942
Conversation
![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 @isimluk, 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 provides a minor but important documentation fix, addressing broken links in the developer guide's Tune FAQ section. The change ensures that new contributors can easily navigate to relevant GitHub issues, improving the overall onboarding experience and accessibility of contribution opportunities.
Highlights
- Documentation Link Fix: Corrected broken URLs within the
doc/source/tune/faq.rstfile. Specifically, the links pointing to GitHub issues labeled 'good first issue' and 'help wanted' were updated to use hyphens instead of spaces in their URL query parameters, ensuring they now correctly filter issues.
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. ↩
isimluk
force-pushed
the
docs-trivial-fix-link
branch
from
6393b74 to
3ed7814
Compare
There was a problem hiding this comment.
Code Review
This pull request fixes broken links in the developer guide by updating the GitHub issue label names in the URLs. The change is correct and improves the documentation. I've added one suggestion to further simplify the URLs for better readability and maintainability.
|
|
||
| We use Github to track issues, feature requests, and bugs. Take a look at the | ||
| ones labeled `"good first issue" <https://github.com/ray-project/ray/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22>`__ and `"help wanted" <https://github.com/ray-project/ray/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22>`__ for a place to start. | ||
| ones labeled `"good first issue" <https://github.com/ray-project/ray/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good-first-issue%22>`__ and `"help wanted" <https://github.com/ray-project/ray/issues?q=is%3Aopen+is%3Aissue+label%3A%22help-wanted%22>`__ for a place to start. |
There was a problem hiding this comment.
Thanks for fixing these broken links! Your change is correct as GitHub labels now use hyphens instead of spaces.
While you're at it, we can simplify these URLs further for better readability and maintainability.
- The
utf8=...parameter is a relic from older web forms and is not necessary for the query to work. - The
is:issueandis:openfilters are redundant as they are the default for the repository's issues page. - The quotes around the label names are also not required since the label names themselves don't contain characters that need quoting.
Here is a cleaner version of the links:
ones labeled `"good first issue" <https://github.com/ray-project/ray/issues?q=label:good-first-issue>`__ and `"help wanted" <https://github.com/ray-project/ray/issues?q=label:help-wanted>`__ for a place to start.
There was a problem hiding this comment.
Thank You for all the suggestion that you so kindly put together.
However, please appreciate that my ambition is to fix human visible issue -- and not to optimize length of the URL.
Also, I think your suggestion about 'is:open' filter being default is not correct as of today.
Signed-off-by: Šimon Lukašík <isimluk@fedoraproject.org>
ray-gardener
bot
added
community-contribution
## Why are these changes needed? Just getting started and found broken links in the developer guide. ## Related issue number N/A ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [x] I've included any doc changes needed for https://docs.ray.io/en/master/. - [x] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [x] This PR is not tested :) Signed-off-by: Šimon Lukašík <isimluk@fedoraproject.org> Signed-off-by: Krishna Kalyan <krishnakalyan3@gmail.com>
## Why are these changes needed? Just getting started and found broken links in the developer guide. ## Related issue number N/A ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [x] I've included any doc changes needed for https://docs.ray.io/en/master/. - [x] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [x] This PR is not tested :) Signed-off-by: Šimon Lukašík <isimluk@fedoraproject.org> Signed-off-by: jugalshah291 <shah.jugal291@gmail.com>
## Why are these changes needed? Just getting started and found broken links in the developer guide. ## Related issue number N/A ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [x] I've included any doc changes needed for https://docs.ray.io/en/master/. - [x] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [x] This PR is not tested :) Signed-off-by: Šimon Lukašík <isimluk@fedoraproject.org> Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
2 participants
Why are these changes needed?
Just getting started and found broken links in the developer guide.
Related issue number
N/A
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.