Skip to content

Refactor/move docusaurus root#493

Open
labdhiongithub7 wants to merge 15 commits intovolcano-sh:masterfrom
labdhiongithub7:refactor/move-docusaurus-root
Open

Refactor/move docusaurus root#493
labdhiongithub7 wants to merge 15 commits intovolcano-sh:masterfrom
labdhiongithub7:refactor/move-docusaurus-root

Conversation

@labdhiongithub7
Copy link
Copy Markdown

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    /kind feature

  • What this PR does / why we need it:
    This PR introduces an migration of the Volcano website from Hugo to Docusaurus.

  • Which issue(s) this PR fixes:
    N/A

labdhiongithub7 and others added 13 commits March 27, 2026 11:22
Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
@volcano-sh-bot
Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign k82cn for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@volcano-sh-bot volcano-sh-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Apr 21, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a 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 migrates the Volcano website from Hugo to Docusaurus, replacing Hugo-specific configuration and content with Docusaurus-compatible files. The review feedback highlights several formatting and syntax issues in the migrated markdown files, such as trailing backticks in code blocks, incorrect shell variable expansion syntax, and broken YAML values. It also identifies artifacts from conversion tools in URLs and text placeholders, along with typos and broken links that need correction.

Comment thread blog/Quick-Start-Volcano.md
Comment thread blog/Volcano-1.10.0-release.md
Comment thread blog/Volcano-1.10.0-release.md
Comment thread blog/hpc-en.md
Comment thread blog/aiqiyi-en.md
Comment thread blog/paddlepaddle-en.md
Comment thread blog/ruitian-en.md
Comment thread blog/ruitian-en.md
Comment thread blog/Volcano-1.9.0-release.md
@JesseStutler
Copy link
Copy Markdown
Member

What's the relationship between this pr and #490?

…with YAML front matter

- README.md: kept Docusaurus migration version, discarded old Hugo README

- Converted 27 user_guide docs from TOML to Docusaurus YAML front matter

- Added user guides to version-v1.12.0/Ecosystem (not v1.10.0)

- Accepted toc-scrollspy.js from upstream

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
@volcano-sh-bot
Copy link
Copy Markdown
Collaborator

Adding label do-not-merge/contains-merge-commits because PR contains merge commits, which are not allowed in this repository.
Use git rebase to reapply your commits on top of the target branch. Detailed instructions for doing so can be found here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

…Guide

- Move user guide docs from versioned_docs/v1.12.0/Ecosystem to docs/UserGuide

- Replace old kebab-case filenames with snake_case user_guide_*.md

- Fix extender: escape curly braces to prevent MDX JSX parsing error

- Fix numa-aware: use self-closing <br/> tags for MDX compatibility

- Fix vnpu: correct broken relative link to volcano_vgpu doc

- Fix capacity: replace broken relative design doc link with GitHub URL

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>
@labdhiongithub7
Copy link
Copy Markdown
Author

#490 was my earlier attempt where I added Docusaurus under a docs-site/ subdirectory. This PR moves it to the repo root and removes Hugo completely so #493 is basically the cleaner, finished version of that work.

@JesseStutler
Copy link
Copy Markdown
Member

#490 was my earlier attempt where I added Docusaurus under a docs-site/ subdirectory. This PR moves it to the repo root and removes Hugo completely so #493 is basically the cleaner, finished version of that work.

@labdhiongithub7 So we only need to review this PR?

本节提供指导帮助您快速上手 Volcano,从部署基本的 Volcano Job/Deployment,到集成 Volcano 队列。

## 前置条件
已成功安装带有 Volcano 组件的 Kubernetes 集群。如果您尚未安装 Volcano,请参阅 [安装指南](/docs/GettingStarted/Installation)。
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you change the translation for Chinese? @labdhiongithub7 https://volcano.sh/zh/docs/tutorials/, why not just migrate the existing doc to the new dir?

Copy link
Copy Markdown
Member

@JesseStutler JesseStutler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious that why CN docs have to put under i18n/zh-Hans? They can put together in docs dir with those English docs? Becasue Hugo seperate En and CN docs through different dirs but still same under dos large dir

Comment thread README.md
Copy link
Copy Markdown
Member

@JesseStutler JesseStutler May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not finish the README yet?

And I remember that we should add a user guide to let new contributors know how we organize the stucture of our website( write the layout is better), and teach if a new contributor wants to add a new doc, where he/she should add, add how to render the website in their local env

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes sir I'm currently working on it

@labdhiongithub7
Copy link
Copy Markdown
Author

#490 was my earlier attempt where I added Docusaurus under a docs-site/ subdirectory. This PR moves it to the repo root and removes Hugo completely so #493 is basically the cleaner, finished version of that work.

@labdhiongithub7 So we only need to review this PR?

yes @JesseStutler

@labdhiongithub7
Copy link
Copy Markdown
Author

I'm curious that why CN docs have to put under i18n/zh-Hans? They can put together in docs dir with those English docs? Becasue Hugo seperate En and CN docs through different dirs but still same under dos large dir

Docusaurus handles i18n differently from Hugo. In Hugo, EN and CN docs can stay under the same large content structure because each language is treated as a separate content tree.

In Docusaurus, English docs under docs/ are considered the source docs, and other languages like Chinese are treated as translations/overrides, so they are placed under i18n/zh-Hans/.... This also helps Docusaurus manage locale routing, versioning, and translation fallback automatically.

@labdhiongithub7
Copy link
Copy Markdown
Author

I'm curious that why CN docs have to put under i18n/zh-Hans? They can put together in docs dir with those English docs? Becasue Hugo seperate En and CN docs through different dirs but still same under dos large dir

Thanks for catching that. You're right there are some minor wording differences. I'll update the file to match the existing translation from the live site exactly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/contains-merge-commits size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants