Feat: Add Starter code for docusaurus #485
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… deviceshare, extender, nodegroup, usage, and resourcequota plugins Signed-off-by: Shive <shiverse94@gmail.com>
Signed-off-by: Shive <shiverse94@gmail.com>
Signed-off-by: Shive <shiverse94@gmail.com>
Signed-off-by: Shive <shiverse94@gmail.com>
Collaborator
|
[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 @shiverse94, 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 represents a significant upgrade to the Volcano project's official website, transitioning its underlying technology from Hugo to Docusaurus. This modernization effort aims to enhance the website's infrastructure, improve content management, and provide a more user-friendly experience for visitors. The changes include a complete overhaul of the documentation structure, integration of a new blog system with existing content, and updates to the build and deployment pipeline. 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. Changelog
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 introduces a comprehensive migration of the Volcano project's website from Hugo to Docusaurus, involving the creation of numerous new documentation files for various plugins (Capacity, Device Share, Extender, Node Group, Resource Strategy Fit, Resource Quota, Usage) and a large collection of blog posts, including release notes and case studies. The Docusaurus configuration files (netlify.toml, docusaurus.config.js, etc.) have been updated to reflect this change, along with new .gitignore rules and updated blog author/tag configurations. Review comments highlight several issues: broken URLs due to encoding errors (_x0002_), hardcoded Algolia API keys that should be environment variables, incorrect image rendering due to unsupported Hugo shortcodes, deprecated HTML <font> tags, and minor formatting inconsistencies like unicode characters and malformed table markdown. Additionally, some documentation dates are set in the future, which might be unintended for static content.
Comment on lines
+166
to
+207
| Symptom:During Volcano upgrade, the image in https://github.com/volcano_x0002_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. | ||
|
|
||
| Cause:volcano-admission-init in the YAML file was executed repeatedly. As a result, Volcano was reset. | ||
|
|
||
| Solution: Upgrade only the necessary components. | ||
|
|
||
| {{<figure library="1" src="aiqiyi-12.png">}} | ||
|
|
||
| Issue 2 | ||
|
|
||
| Symptom: When list_and_watch was used to monitor vcjob status, the watch connection broke every 80 to 90 seconds when there were no new events, and the disconnection duration varied. Such issue did not occur when the same code was used to monitor pods. | ||
|
|
||
| Cause: The default http timeout for CRD objects in Kubernetes is time.Duration(float64(minRequestTimeout) * (rand.Float64() + 1.0)), where miniRequestTimeout is set to 1 minute. You can specify timeoutSecond on the client to avoid this issue. | ||
|
|
||
| {{<figure library="1" src="aiqiyi-13.png">}} | ||
|
|
||
| Issue 3 | ||
|
|
||
| Symptom: The container entry address in Jarvis is a bash script. When the script was run in Kubernetes, a container did not exit until 30 seconds after the stop command was delivered. | ||
|
|
||
| Cause:Bash did not pass the signal to child processes. When graceful stop timeout was reached, the daemon process detected that the container had not exited and sent a SIGKILL signal to kill the bash script and exit the container. However, other processes in the container had no chance to clean up. | ||
|
|
||
| Solution:Use dum-init to run a script such as the following entry script: | ||
|
|
||
| ``` | ||
| #!/usr/bin/dumb-init /bin/bash | ||
|
|
||
| my-web-server & # launch a process in the background | ||
|
|
||
| my-other-server # launch another process in the foreground | ||
|
|
||
| ``` | ||
|
|
||
| 1.6Modifications on Volcano | ||
|
|
||
| - The SVC plugin now supports the input parameter nodeport. It means when we create a vcjob and pass the SVC parameter, a nodeport will be created, so our TensorBoard and other services can be accessed externally. | ||
|
|
||
| - We have fixed the bug that creation fails when the name of the SSH plugin exceeds 63 bytes. | ||
|
|
||
| - Volcano has fixed the bug in the queue capability that resources can be used over the capability. For details, see https://github.com/volcano-sh/volcano/issues/921. | ||
|
|
||
| - After a vcjob is annotated, if a pod fails, the vcjob deletion is not triggered. For details, see https://github.com/volcano_x0002_sh/volcano/issues/805. |
There was a problem hiding this comment.
The URLs in this section contain _x0002_ which seems to be an encoding error for -. This will result in broken links. Please replace volcano_x0002_sh with volcano-sh.
Comment on lines
+77
to
+79
| appId: process.env.ALGOLIA_APP_ID || 'KXO9RCDQGX', | ||
| apiKey: process.env.ALGOLIA_API_KEY || '6f21a78a8681d337c3b93995f3291e08', | ||
| indexName: 'volcano', |
There was a problem hiding this comment.
Hardcoding API keys, even as fallbacks, is a significant security risk. The Algolia API key should be loaded exclusively from environment variables. Please remove the hardcoded key from the configuration file to prevent accidental exposure.
algolia: {
appId: process.env.ALGOLIA_APP_ID,
apiKey: process.env.ALGOLIA_API_KEY,| ## Overall Architecture | ||
|
|
||
|
|
||
| {{<figure library="1" src="arch_1.png" title="Application scenarios of Volcano">}} |
There was a problem hiding this comment.
The Hugo shortcode {{< figure ... >}} is used here to display an image. This syntax is not supported by Docusaurus and will not render the image correctly. Please replace it with the standard Markdown syntax for images (). This issue is present in many files across the PR.
Suggested change
| {{<figure library="1" src="arch_1.png" title="Application scenarios of Volcano">}} | |
|  |
|
|
||
| Kthena was built to conquer these challenges. Rather than replacing existing inference engines (like vLLM or SGLang), Kthena acts as an intelligent orchestration layer atop them, deeply integrated into Kubernetes. | ||
|
|
||
| <div style="text-align: center;"> {{<figure library="1" src="./kthena/kthena-arch.svg">}} |
There was a problem hiding this comment.
The Hugo shortcode {{< figure ... >}} is not supported by Docusaurus and will not render the image. Please replace it with standard Markdown image syntax or an appropriate MDX component. This issue is present in multiple files throughout the PR.
Suggested change
| <div style="text-align: center;"> {{<figure library="1" src="./kthena/kthena-arch.svg">}} | |
| <div style="text-align: center;">  </div> |
|
|
||
| __WPS__ | ||
|
|
||
| ——WPS，WRF Pre-processing System） |
There was a problem hiding this comment.
This line appears to have a formatting or copy-paste error. The —— and full-width parenthesis ） should be corrected for consistency and readability.
Suggested change
| ——WPS，WRF Pre-processing System） | |
| WPS (WRF Pre-processing System) |
Comment on lines
+162
to
+166
| | ||
| if status.Succeeded >= minSuccess { | ||
| status.State.Phase = vcbatch.Completed | ||
| return true | ||
| } |
There was a problem hiding this comment.
There appear to be zero-width space characters () in this code block, which can cause rendering issues or copy-paste errors. These should be removed.
Suggested change
| | |
| if status.Succeeded >= minSuccess { | |
| status.State.Phase = vcbatch.Completed | |
| return true | |
| } | |
| if status.Succeeded >= minSuccess { | |
| status.State.Phase = vcbatch.Completed | |
| return true | |
| } |
| date: 2022-12-28 | ||
| authors: [volcano] | ||
| --- | ||
| >2On 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. |
There was a problem hiding this comment.
There seems to be a typo with an extra 2 at the beginning of this line.
Suggested change
| >2On 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. | |
| >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. |
| date: 2023-08-11 | ||
| authors: [volcano] | ||
| --- | ||
| <font face="Arial" size=4> As artificial intelligence (AI) technologies advance and large language models (LLMs) grow more popular, the demand for AI compute has been booming. This has generated huge demand for high-performance scheduling for the AI and for hardware like AI chips.</font> |
There was a problem hiding this comment.
The use of the <font> tag is deprecated in HTML5 and should be avoided. Styling should be handled by CSS. Please remove the <font> tags and use Markdown emphasis or Docusaurus-specific components (like admonitions for colored text) for styling.
Suggested change
| <font face="Arial" size=4> As artificial intelligence (AI) technologies advance and large language models (LLMs) grow more popular, the demand for AI compute has been booming. This has generated huge demand for high-performance scheduling for the AI and for hardware like AI chips.</font> | |
| As artificial intelligence (AI) technologies advance and large language models (LLMs) grow more popular, the demand for AI compute has been booming. This has generated huge demand for high-performance scheduling for the AI and for hardware like AI chips. |
Comment on lines
+130
to
+132
| ``` | ||
| # kubectl create -f priority_1000.yaml | ||
| ``` |
There was a problem hiding this comment.
For consistency and proper syntax highlighting, it's best to specify the language for all code blocks. This block is missing the bash language identifier.
Suggested change
| ``` | |
| # kubectl create -f priority_1000.yaml | |
| ``` | |
| # kubectl create -f priority_1000.yaml |
|
|
||
| | Organization | Contact (Github UserName) | Environment | Description| | ||
| |--------------------------------------| ------------- | ------------- | ------------- | | ||
| | [Baidu Inc](https://www.baidu.com) |[@tizhou86](https://github.com/tizhou86)| Production | The scheduler for offline training of the PaddlePaddle deep learning framework | |
There was a problem hiding this comment.
The markdown for this table row appears to be malformed. There should be a space after the | character for the second column to ensure it renders correctly across all markdown parsers.
Suggested change
| | [Baidu Inc](https://www.baidu.com) |[@tizhou86](https://github.com/tizhou86)| Production | The scheduler for offline training of the PaddlePaddle deep learning framework | | |
| | [Baidu Inc](https://www.baidu.com) | [@tizhou86](https://github.com/tizhou86)| Production | The scheduler for offline training of the PaddlePaddle deep learning framework | |
Contributor
|
Hi @shiverse94 |
volcano-sh-bot
added
the
do-not-merge/work-in-progress
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Which issue(s) this PR fixes: