Docs(Plugins): Refactor plugins to be a submenu under Scheduler #441
Conversation
volcano-sh-bot
added
the
do-not-merge/invalid-commit-message
|
[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 @labdhiongithub7! It looks like this is your first PR to volcano-sh/website 🎉 |
volcano-sh-bot
added
the
size/XXL
Summary of ChangesHello @labdhiongithub7, 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 significantly enhances the documentation experience by reorganizing the 'Plugins' section. Instead of a single, lengthy document, each plugin now has its own dedicated page, making it easier for users to find specific information. This restructuring improves the clarity and maintainability of the documentation, providing a more intuitive browsing experience. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request is a great improvement, refactoring the plugin documentation into a more organized and navigable structure under the Scheduler menu. The migration of content into individual files for both English and Chinese versions significantly enhances clarity. My review identified a few minor inconsistencies in the menu item weights within the Chinese documentation that could lead to a different navigation order compared to the English version. I have also pointed out a minor file encoding issue. Addressing these points will ensure a consistent experience across both languages.
| @@ -0,0 +1,84 @@ | |||
| +++ | |||
There was a problem hiding this comment.
This file starts with a UTF-8 Byte Order Mark (BOM) character (\ufeff). While many editors and tools handle this correctly, it's best practice to remove it to prevent potential issues with some environments or tools that don't expect it. Please save the file as UTF-8 without BOM.
| +++ | |
| +++ |
content/zh/docs/proportion.md
Outdated
| linktitle = "Proportion" | ||
| [menu.docs] | ||
| parent = "plugins" | ||
| weight = 5 |
There was a problem hiding this comment.
The weight for this plugin is set to 5, which is inconsistent with the English documentation (weight = 8). Additionally, this conflicts with the binpack.md plugin which also has weight = 5. To ensure consistent menu ordering between languages and avoid conflicts, please update the weight to 8.
| weight = 5 | |
| weight = 8 |
content/zh/docs/sla.md
Outdated
| linktitle = "SLA" | ||
| [menu.docs] | ||
| parent = "plugins" | ||
| weight = 9 |
There was a problem hiding this comment.
The weight for this plugin is set to 9, which is inconsistent with the English documentation where it is 12. To ensure the menu order is the same for both English and Chinese versions, please change the weight to 12.
| weight = 9 | |
| weight = 12 |
content/zh/docs/task-topology.md
Outdated
| linktitle = "Task-topology" | ||
| [menu.docs] | ||
| parent = "plugins" | ||
| weight = 6 |
There was a problem hiding this comment.
The weight for this plugin is set to 6, which is inconsistent with the English documentation (weight = 9). This also conflicts with the priority.md plugin which has the same weight. To maintain consistent menu ordering across languages and resolve the conflict, please update the weight to 9.
| weight = 6 | |
| weight = 9 |
labdhiongithub7
force-pushed
the
refactor-plugins-submenu
branch
from
5717259 to
cd50ba9
Compare
volcano-sh-bot
removed
the
do-not-merge/invalid-commit-message
…ctored Plugins to be a submenu under Scheduler menu- Migrated existing plugin content to separate files- Created plugins-overview.md as the parent menu item- Split 11 plugins into separate documentation files: * Gang, Binpack, Priority, DRF, Proportion * Task-topology, Predicates, Nodeorder * SLA, TDM, Numa-aware- Applied to both English and Chinese documentation- Removed old plugins.md files- Fixed blog post dateday format issuesStructure: Scheduler > Plugins (submenu) > Individual Plugin Pages Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com>
labdhiongithub7
force-pushed
the
refactor-plugins-submenu
branch
from
cd50ba9 to
6ab0962
Compare
|
Hi @labdhiongithub7 Apologies for interrupting, but I do not think a 3000-liner PR is relevant or manually coded. My motive in intervention is that such PRs are usually not reviewed or merged. |
- Update proportion.md weight to 8 (was 5) - Update sla.md weight to 12 (was 9) - Update task-topology.md weight to 9 (was 6) - Update lastmod dates to 2026-01-19 (was 2025-11-11) - Fix UTF-8 BOM in plugins-overview.md This ensures consistent menu ordering between EN and ZH versions. Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com>
Hey @codeEvolveZenith345! Fair concern! The +3k lines is from splitting |
Reviews are supposed to be done by maintainers, But I would suggest verifying the information added, as per my knowledh=ge the original file to be split was a ~170 liner and this makes the content to ~3200 liner, which usually brings a lot of misinformation concerns you would have known this, if you had contributed before, therefore I would recommend manually/self verification of the content added. |
|
Thanks for your work, it's great refactor, but what I expect is that we could show a button here at plugin to show sub-menu: You should also test in your local env to use hugo version v0.57.2 to take a look |
After reviewing the Netlify preview, I agree with this and had a suggestion that the new plugins should be made children of the plugins page/section instead of being on the same page. |
Thanks for the feedback @JesseStutler ! I’ll update the Plugins menu to make it expandable so the individual plugin pages are shown underneath, and I’ll test locally to ensure the submenu works as expected. |
4 participants
Description
Refactored Plugins documentation to be a submenu under Scheduler, improving navigation and structure as requested in #424.
Changes Made
plugins-overview.mdas the parent menu itemNew Structure
Scheduler
├── Overview
├── Actions
├── Plugins
│ ├── Gang
│ ├── Binpack
│ ├── Priority
│ ├── DRF
│ ├── Proportion
│ ├── Task-topology
│ ├── Predicates
│ ├── Nodeorder
│ ├── SLA
│ ├── TDM
│ └── Numa-aware
└── Scenario & Configuration
Testing
Closes #424
Closes #425
Closes #426