-
Notifications
You must be signed in to change notification settings - Fork 98
docs: add deviceshare dependency warning to Predicate plugin documentation #443
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
docs: add deviceshare dependency warning to Predicate plugin documentation #443
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
|
Welcome @aaradhychinche-alt! It looks like this is your first PR to volcano-sh/website 🎉 |
Summary of ChangesHello @aaradhychinche-alt, 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 a potential misconfiguration issue by clarifying an implicit dependency between the 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. 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request effectively addresses an important documentation gap by adding a warning about the dependency of the deviceshare plugin on the Predicate plugin. The change is consistently applied to both English and Chinese documentation, which will help users avoid configuration errors. I've included a couple of minor suggestions to improve the conciseness of the new warning messages for better readability.
Arhell
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Signed-off-by: Aaradhy Chinche <aaradhychinche@gmail.com>
9388ccb to
061d197
Compare
|
@Arhell the dco was failing i have committed now once more can you review the pr once more ? thank you !! |
|
/lgtm |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't we create the deviceshare plugin section first? This is the original issue:
volcano-sh/volcano#4502
The relevant docs are:
https://github.com/volcano-sh/volcano/blob/master/docs/user-guide/how_to_use_gpu_number.md
https://github.com/volcano-sh/volcano/blob/master/docs/user-guide/how_to_use_gpu_sharing.md
https://github.com/volcano-sh/volcano/blob/master/docs/user-guide/how_to_use_volcano_vgpu.md
https://github.com/volcano-sh/volcano/blob/master/docs/user-guide/how_to_use_vnpu.md
Thank you for picking this up btw
|
|
||
| The Predicate Plugin calls the PredicateGPU with pod and nodeInfo as parameters to evaluate and pre-select jobs based on the results. | ||
|
|
||
| > ⚠️ **Warning** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure just putting this in makes any sense.
We shall add a section about the deviceshare plugin first and mention the dependecy there I think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary
The deviceshare plugin has an implicit dependency on the Predicate plugin, but this was not documented previously. As a result, users could enable deviceshare without enabling Predicate, leading to configuration errors and unexpected behavior.
Changes
Rationale
Making this dependency explicit helps users avoid misconfiguration and improves the robustness of the plugin ecosystem by clearly documenting required plugin relationships.
Fixes #410