-
Notifications
You must be signed in to change notification settings - Fork 81
docs: Add deviceshare plugin dependency warning to Predicate plugin documentation #409
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?
Conversation
|
Welcome @csh0101! |
|
[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 |
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 of Changes
Hello @csh0101, 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 aims to improve user experience and prevent configuration errors by clarifying a critical plugin dependency. It updates the documentation for the Predicate plugin to explicitly state its requirement for the deviceshare plugin, ensuring users are aware of this implicit relationship before encountering issues.
Highlights
- Documentation Update: Added a crucial warning to the Predicate plugin documentation, explicitly stating that the
deviceshareplugin has a direct dependency on thePredicateplugin and will not function without it being enabled. - Multi-language Support: The dependency warning has been added to both the English (
content/en/docs/plugins.md) and Chinese (content/zh/docs/plugins.md) versions of the plugin documentation to ensure broad accessibility.
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. ↩
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 adds an important warning about the deviceshare plugin's dependency on the Predicate plugin to the documentation in both English and Chinese. The changes are valuable for preventing configuration errors. The review suggests minor improvements to the consistency and readability of the warning messages.
content/en/docs/plugins.md
Outdated
|
|
||
| The Predicate Plugin calls the PredicateGPU with pod and nodeInfo as parameters to evaluate and pre-select jobs based on the results. | ||
|
|
||
| **Important Note**: The deviceshare plugin has a dependency on the Predicate plugin and cannot function without it being enabled. |
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.
For better readability and consistency, wrap component names in backticks and capitalize Plugin to align with the document's style (e.g., "Predicate Plugin" on line 115).
| **Important Note**: The deviceshare plugin has a dependency on the Predicate plugin and cannot function without it being enabled. | |
| **Important Note**: The `deviceshare` plugin has a dependency on the `Predicate` Plugin and cannot function without it being enabled. |
content/zh/docs/plugins.md
Outdated
|
|
||
| Predicate plugin通过pod、nodeInfo作为参数,调用predicateGPU,根据计算结果对作业进行评估预选。 | ||
|
|
||
| **重要提示**: deviceshare插件依赖于Predicate插件,不能在Predicate插件未启用的情况下独立运行。 |
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.
To improve consistency and clarity, wrap English component names like deviceshare and Predicate in backticks and use the English word plugin instead of 插件 to match the rest of the document (e.g., line 111: Predicate plugin).
| **重要提示**: deviceshare插件依赖于Predicate插件,不能在Predicate插件未启用的情况下独立运行。 | |
| **重要提示**: `deviceshare` plugin 依赖于 `Predicate` plugin,必须启用 `Predicate` plugin 才能运行。 |
|
assign @william-wang |
|
Please sign your commit using |
Signed-off-by: cs <[email protected]>
I use commit -s |
Description
Add important dependency information to the Predicate plugin documentation to inform users that the deviceshare plugin requires the Predicate plugin to be enabled.
Changes Made
Files Modified
content/en/docs/plugins.mdcontent/zh/docs/plugins.mdRationale
Users may enable the deviceshare plugin without realizing it depends on the Predicate plugin, leading to configuration issues. This documentation update helps prevent such problems by making the dependency explicit.
Before/After
Before: No mention of deviceshare dependency on Predicate plugin
After: Clear warning in both language versions: