Minor docs changes #4587
Minor docs changes #4587
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 @hajnalmt, 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 minor maintenance tasks to enhance the project's documentation accuracy and developer workflow. It updates several outdated links within the development guides, adds specific files and directories to the .gitignore to streamline local development, and corrects a few minor typographical errors across documentation and test files. The overall aim is to improve the project's maintainability and ease of use for contributors.
Highlights
- Documentation Link Updates: Updated outdated Go wiki links in
contribute.mdanddocs/development/development.mdto their newgo.devcounterparts, ensuring documentation remains accurate and accessible. - Gitignore Enhancements: Added
.tool-versionsandvolcano-e2e-logs/to.gitignoreto improve local development experience by preventing unnecessary files from being tracked by Git. - Typo Corrections: Corrected minor typographical errors in
docs/design/capacity-scheduling.mdandpkg/scheduler/plugins/capacity/capacity_test.gofor improved clarity and code correctness.
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.
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. ↩
volcano-sh-bot
added
the
size/S
There was a problem hiding this comment.
Code Review
This pull request introduces several minor but useful improvements. It updates broken documentation links to point to the new go.dev domain, which is a necessary maintenance task. The .gitignore file is updated to exclude the ASDF tool versions file and the e2e log directory, which will improve the developer experience by preventing local files from being accidentally committed. Additionally, a typo in the capacity scheduling design document is fixed, and a test setup bug in capacity_test.go is corrected, enhancing the correctness of the test suite. All changes are well-justified and correctly implemented.
Fixing development docs links. Adding e2e log directory and ASDF tools file to gitignore. Fix typo in capacity_test.go. Signed-off-by: Hajnal Máté <[email protected]>
hajnalmt
force-pushed
the
minor-development-docs-changes
branch
from
6c97e8a to
bd1302b
Compare
|
/retest |
|
@hajnalmt: Cannot trigger testing until a trusted user reviews the PR and leaves an In response to this:
Instructions 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. |
|
/ok-to-test |
volcano-sh-bot
added
the
ok-to-test
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Monokaix The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
volcano-sh-bot
added
the
approved
4 participants
No actual code changes in this PR.
I am fixing a view development docs links since https://github.com/golang/go/wiki is not available anymore.
Adding e2e log directory and ASDF tools file to gitignore.
Fix typo in capacity_test.go.
What type of PR is this?
Mostly doc link fixes.
Also fixing a typo in the capacity_test.go.
Additionally I want to add the .tool-versions file and the volcano-e2e-logs directory to .gitignore.
I am using ASDF to manage my dependencies like kubectl and this can ease the development for people like me.
The volcano-e2e-logs directory is not escaped in the gitignore, so after I run an e2e test locally git will try to add the directory to the commit always (without an empty content because the *.log files are escaped.)
What this PR does / why we need it:
It contains minor improvements/fixes.
Which issue(s) this PR fixes:
If it's possible I wouldn't create a separate issue for any of this.
Special notes for your reviewer:
Does this PR introduce a user-facing change?