Fixes Sidebar Duplication & Refactor Plugins Documentation#459
Fixes Sidebar Duplication & Refactor Plugins Documentation#459KushguptaPST wants to merge 2 commits intovolcano-sh:masterfrom
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 |
volcano-sh-bot
added
the
size/XXL
Summary of ChangesHello @KushguptaPST, 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 project's documentation by addressing structural issues and expanding content. It resolves sidebar navigation problems by disambiguating versioned introduction pages and improves maintainability through modularizing the plugins documentation. Additionally, it introduces a robust versioning strategy for documentation and adds a wealth of new articles covering various aspects of the project. 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
|
KushguptaPST
force-pushed
the
refactor-plugins-docs
branch
from
232e217 to
471c510
Compare
…nd blog build errors Squashed commit addressing: - Plugin docs refactoring - Blog frontmatter sanitization - Netlify Docusaurus config (Node 20) Signed-off-by: KushguptaPST <kushg0082@gmail.com>
KushguptaPST
force-pushed
the
refactor-plugins-docs
branch
from
471c510 to
f71f5d1
Compare
![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 PR does a great job of refactoring the documentation by splitting the large plugins document and versioning the introduction to fix sidebar duplication. The migration to a more structured documentation system is a significant improvement. I've found several typos and formatting issues in the newly added markdown files, which I've detailed in the specific comments. Overall, these are great changes that improve the maintainability and user experience of the documentation.
I am having trouble creating individual review comments. Click here to see my feedback.
blog/Volcano-1.9.0-release.md (119)
There is an extra space in the link path how_to _use_nodegroup_plugin.md, which will break the link. Please remove the space.
The scheduling plugin for this feature is called nodegroup, for a complete example of its use see: [How to use nodegroup plugin](https://github.com/volcano-sh/volcano/blob/master/docs/user-guide/how_to_use_nodegroup_plugin.md).
blog/1.4-release-en.md (27-36)
The links to the design documents for proportional.md, numa-aware.md, and multi-scheduler.md are likely broken due to the documentation refactoring in this PR. They point to the old docs/design directory structure. Please update these links to their new locations to ensure they are not broken for readers.
blog/aiqiyi-en.md (223)
This URL contains _x0002_, which appears to be an encoding error for a hyphen (-). This will result in a broken link. Please replace volcano_x0002_sh with volcano-sh.
- After a vcjob is annotated, if a pod fails, the vcjob deletion is not triggered. For details, see https://github.com/volcano-sh/volcano/issues/805.
blog/aiqiyi-en.md (182)
This URL contains _x0002_, which appears to be an encoding error for a hyphen (-). This will result in a broken link. Please replace volcano_x0002_sh with volcano-sh.
Symptom:During Volcano upgrade, the image in https://github.com/volcano-sh/volcano/blob/master/installer/volcano-development.yaml was directly modified, and kubectl apply -f `yaml file` was executed. The existing queues and vcjobs all disappeared.
blog/1.4-release-en.md (13)
There is a duplicate frontmatter separator (---). This is invalid and will likely cause parsing errors when building the site. Please remove this extra separator.
blog/Volcano-1.10.0-release.md (103)
There is a typo in memeory. It should be memory.
memory: 128Gi
blog/Volcano-1.13.0-release.md (368)
This line has a markdown table formatting error. There is a missing space before the final pipe |, which will break the table rendering. Please add a space for correct formatting.
| @hajnalmt | @kevin-wangzefeng | @linuxfhy |
blog/Volcano-1.9.0-release.md (75)
There is a typo in memeory. It should be memory.
memory: 128Gi
blog/Volcano-1.10.0-release.md (124)
There is a typo in Kube-sheduler. It should be Kube-scheduler.
Once a Pod is created, it is considered ready for scheduling. In Kube-scheduler, it will try its best to find a suitable node to place all pending Pods. However, in reality, some Pods may be in a "lack of necessary resources" state for a long time. These Pods actually interfere with the decision-making and operation of the scheduler (and downstream components such as Cluster AutoScaler) in an unnecessary way, causing problems such as resource waste. Pod Scheduling Readiness is a new feature of Kube-scheduler. In Kubernetes v.1.30 GA, it has become a stable feature. It controls the scheduling timing of Pods by setting the schedulingGates field of the Pod.
blog/Quick-Start-Volcano.md (34)
There is a typo in kind luster. It should be kind cluster.
**NOTE**: Ensure that the images are correctly loaded to your Kubernetes cluster. For example, if you are using [kind cluster](https://github.com/kubernetes-sigs/kind), run the ```kind load docker-image <image-name>:<tag> ``` command for each image.
blog/ING_case-en.md (14)
There appears to be a typo at the beginning of the line. The 2 in >2On should likely be removed.
>On October 26, 2022, Krzysztof Adamski and Tinco Boekestijn from ING Group delivered a keynote speech "Efficient Scheduling Of High Performance Batch Computing For Analytics Workloads With Volcano" at KubeCon North America. The speech focused on how Volcano, a cloud native batch computing project, supports high-performance scheduling for big data analytics jobs on ING's data management platform.
blog/how-volcano-boosts-distributed-training-and-inference-performance.md (18)
There is a typo in the linktitle. It should be performance instead of performanc.
linktitle: How volcano boosts distributed training and inference performance
blog/how-volcano-boosts-distributed-training-and-inference-performance.md (66)
There is a missing space in onVolcano Slack. It should be on Volcano Slack.
- Slack: Join the conversation on Volcano Slack.
blog/hpc-en.md (196)
The path /etc/Volcano uses a capital 'V', which is inconsistent with other documentation files that use /etc/volcano. On case-sensitive systems like Linux, this will point to a different directory and could cause issues. Please use the lowercase version for consistency.
MPI_HOST=`cat /etc/volcano/mpiworker.host | tr "\n" ","`;
blog/introducing-kthena-redefining-llm-inference-for-the-cloud-native-era.md (168)
There appears to be duplicated text at the end of this line, likely from a copy-paste error. Please remove the extraneous content.
**Join us to unlock the full potential of Cloud Native LLMs!**
blog/pengcheng-en.md (179)
There is a typo in Openl-Octopus. It should be OpenI-Octopus for consistency with the rest of the document.
- The scheduler notifies OpenI-Octopus to stop the jobs at the service layer.
Addressed issues: - Fixed typos (memeory, Kube-sheduler, luster, etc.) - Fixed broken links and encoding errors - Fixed table and frontmatter formatting Signed-off-by: KushguptaPST <kushg0082@gmail.com>
2 participants
This PR improves the documentation structure and resolves sidebar navigation issues.
. What happened: The sidebar was showing multiple "Introduction" items because several versioned files shared the same title.
. The Fix: I updated the titles in the versioned documentation (e.g., docs/v1-12-0/index.md) to include their version number (e.g., "Introduction v1-12-0"). Now, the sidebar clearly distinguishes between them.
. What happened: The plugins documentation was a single, long file ( plugins.md) that was hard to maintain.
. The Fix: I broke this down into a organized docs/plugins/ directory. Now, each plugin (like Gang, Binpack) has its own dedicated file, making it much easier to read and update.
Related Issues
Fixes #424