Refactor/move docusaurus root by labdhiongithub7 · Pull Request #493 · volcano-sh/website

labdhiongithub7 · 2026-04-21T10:57:23Z

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

gemini-code-assist

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.

JesseStutler · 2026-05-06T03:23:39Z

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

volcano-sh-bot · 2026-05-06T19:27:35Z

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.

labdhiongithub7 · 2026-05-06T22:13:50Z

#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 · 2026-05-09T08:23:52Z

#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?

JesseStutler · 2026-05-09T08:26:50Z

+本节提供指导帮助您快速上手 Volcano，从部署基本的 Volcano Job/Deployment，到集成 Volcano 队列。
+
+## 前置条件
+已成功安装带有 Volcano 组件的 Kubernetes 集群。如果您尚未安装 Volcano，请参阅 [安装指南](/docs/GettingStarted/Installation)。


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?

JesseStutler

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

JesseStutler · 2026-05-09T08:31:51Z

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

Yes sir I'm currently working on it

labdhiongithub7 · 2026-05-09T16:50:24Z

#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 · 2026-05-09T16:55:58Z

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 · 2026-05-09T17:12:30Z

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

JesseStutler · 2026-05-14T06:20:54Z

Thanks for your great work! I think it's approaching to get merged. Could you resolve the conflicts and push again? @labdhiongithub7

JesseStutler · 2026-05-14T06:24:04Z

+
+We use [Docusaurus](https://docusaurus.io/) to format and generate our website, and [Netlify](https://www.netlify.com/) to manage the deployment of the site. Docusaurus is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown (with YAML front matter), and Docusaurus wraps them up into a website.
+
+Please see [How to contribute](https://github.com/volcano-sh/website/blob/master/CODE_OF_CONDUCT.md) for instructions on how to contribute, if you are not familiar with the GitHub workflow.


Why is how to contribute linked to the Code of conduct? @labdhiongithub7 Please check , if you're using AI agent to help finish to docs, you should verify and make sure all the thing are correct. AI may have illusion

Sorry @JesseStutler for the oversight, I'll be more careful . I'll update it

JesseStutler · 2026-05-14T06:27:13Z

+
+Please see [How to contribute](https://github.com/volcano-sh/website/blob/master/CODE_OF_CONDUCT.md) for instructions on how to contribute, if you are not familiar with the GitHub workflow.
+
+## Quickstart


I think the old README docs is also not correct, this section is not a quickstart guide, quick start should teach users how to add new docs/update docs and run in the local, this section may be more like a preview section and should be put at last, not at the beginning I think

This was carried over from the old README. I'll restructure it under preview section and update the quick start guide

JesseStutler · 2026-05-14T06:31:34Z

Also please add a section to teach that how to archive a version of docs when a new version get released @labdhiongithub7

Got it! The Docusaurus docs already cover this pretty well (https://docusaurus.io/docs/versioning), so I'll add a short section in the README summarizing it and link back to the official docs for more details.

JesseStutler · 2026-05-14T06:33:31Z

Hi @labdhiongithub7 I want to learn that where do you mark the current version as the latest?

JesseStutler · 2026-05-14T06:39:28Z

+├── versioned_sidebars/         # Sidebar snapshots for past releases
+│
+├── i18n/zh-Hans/               # Chinese (Simplified) translations
+│   ├── docusaurus-plugin-content-docs/


I'm curious that why Chinese dir name seems so long, you can see for the english doc, it's just docs/
, but Chinse should be i18n/zh-Hans/docusaurus-plugin-content-docs. Does it have to be song long? Could it be like i18n/zh-Hans/docs/<section> and i18n/zh-Hans/blog/ also? It will more clear for me

Actually it's a convention by Docusaurus here is the reference:
https://docusaurus.io/docs/i18n/introduction#translation-files-location

I got it, thanks, here is another repo that can be refered: https://github.com/koordinator-sh/website/blob/main/README.md, and we need to clarify that how Chinese docs be organized

labdhiongithub7 · 2026-05-14T07:13:38Z

Hi @labdhiongithub7 I want to learn that where do you mark the current version as the latest?

The current version is marked as latest in docusaurus.config.js, for English and In i18n/zh-Hans/docusaurus-plugin-content-docs/current.json for Chinese

de6p

public/ folder should be merged into static/ folder where needed, then removed to avoid confusion.

de6p · 2026-05-18T03:31:41Z

-
-[context.next.environment]
-HUGO_ENABLEGITINFO = "true"
+[[redirects]]


The /* → /index.html rule in netlify.toml is an SPA fallback pattern. Docusaurus already outputs static HTML per route (build/docs/.../index.html, etc.), so this rule isn’t needed and can hide real 404s by serving the homepage with a 200 for missing paths.

de6p · 2026-05-18T03:32:43Z

+          sidebarPath: require.resolve('./sidebar.js'),
+          showLastUpdateTime: true,
+          showLastUpdateAuthor: false,
+          editUrl: "https://github.com/volcano-sh/website/tree/main/",


editUrl points to main, default branch is master

de6p · 2026-05-18T03:34:26Z

+
+### Prepare
+
+Install [prometheus](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus) or [prometheus-adaptor](https://github.com/prometheus-community/helm- c harts/tree/main/charts/prometheus-adapter), and [prometheus-node-exporter](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-node-exporter), The real load of the node is exposed to the `Volcano descheduler` through node-exporter and prometheus.


Space in helm- c harts breaks the link (also in v1.11/v1.12 versioned copies).

de6p · 2026-05-18T03:49:35Z

+---
+This section provides guidance to help you quickly get started with Volcano, from deploying a basic Volcano Job/Deployment, to integrating with Volcano Queues
+## Prerequisites
+A Kubernetes cluster with Volcano components need to be installed successfully. If you haven't installed Volcano yet, please refer to [Installation](https://volcano.sh/en/docs/installation/).


Old website link, When someone clicks that link on the new site, they go to a URL that may not exist anymore → 404 or wrong page.

de6p

Docs still link to Hugo URLs and Hugo file paths; they need to link to Docusaurus URLs and the current docs/ file paths instead.

There alot of files, so please fix this .

docs/GettingStarted/Tutorials.md, docs/Contribution/VolcanoContribution.md, docs/UserGuide/user_guide_how_to_configure_scheduler.md, all matching versioned_docs/**/Tutorials.md and VolcanoContribution.md, i18n/zh-Hans/.../GettingStarted/Tutorials.md, .../how-to-configure-scheduler.md, and i18n/zh-Hans/.../blog/Volcano-1.10.0|1.11.0|1.13.0-release.md.

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>

…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>

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

…fixes Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

de6p

lgtm 🚀

volcano-sh-bot · 2026-05-26T13:37:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: de6p, JesseStutler

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [JesseStutler]

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

JesseStutler · 2026-05-26T13:41:11Z

/lgtm

volcano-sh-bot requested review from JesseStutler and kevin-wangzefeng April 21, 2026 10:57

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

gemini-code-assist Bot reviewed Apr 21, 2026

View reviewed changes

katara-Jayprakash mentioned this pull request Apr 24, 2026

✨ feat: Migrating from hugo to docusasurus #454

Closed

volcano-sh-bot added the do-not-merge/contains-merge-commits label May 6, 2026

JesseStutler reviewed May 9, 2026

View reviewed changes

JesseStutler reviewed May 14, 2026

View reviewed changes

de6p reviewed May 18, 2026

View reviewed changes

Comment thread docusaurus.config.js Outdated

labdhiongithub7 and others added 12 commits May 26, 2026 15:27

switch Netlify build from Hugo to Docusaurus

4fcee36

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

remove duplicate Netlify config from docs-site

778edee

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

Fix Netlify for docs-site build

a925b88

Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com> Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

added truncate tags in English and Chinese blog posts

1dacca4

Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com> Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

fixed broken links and images

25a932f

Signed-off-by: labdhiongit7 <labdhigandhinew077@gmail.com> Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

Update docs-site/docs/Concepts/VolcanoJob.md

be5396c

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

fix: address gemini review comments

3cab0f7

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

fix: convert TOML front matter to YAML syntax in UserGuide docs

5bae010

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

fixed UI, fonts, and YAML rendering

2933ac4

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

unified dark theme backgrounds

fe61755

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

fix: clean hero section CSS

d163235

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

refactor: move docusaurus to root and remove hugo

4166e4f

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

labdhiongithub7 force-pushed the refactor/move-docusaurus-root branch from da3ee61 to f67b2de Compare May 26, 2026 10:08

labdhiongithub7 added 8 commits May 26, 2026 15:58

docs: add user guides to v1.12.0 with YAML front matter

be3209c

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

docs: update README for Docusaurus migration

b272901

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

fixed i18n

f476c3b

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

docs: standardize Docusaurus docs structure

f255bb4

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

align zh-Hans docs,blog structure and fixed Docusaurus links

256f604

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

address review comments and update translations

7765d19

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

fix: remove leftover Hugo user guide files and apply VolcanoJob typo …

dd0ea14

…fixes Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

labdhiongithub7 force-pushed the refactor/move-docusaurus-root branch from f67b2de to dd0ea14 Compare May 26, 2026 10:33

labdhiongithub7 added 2 commits May 26, 2026 17:01

updated the config.js and the UnifiedScheduling file

c990d39

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

fix: resolve broken anchor links in UnifiedScheduling docs

68ca6d4

Signed-off-by: labdhiongit7 <img_2022034@iiitm.ac.in>

de6p approved these changes May 26, 2026

View reviewed changes

volcano-sh-bot assigned JesseStutler May 26, 2026

volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label May 26, 2026

volcano-sh-bot merged commit 9f8e34b into volcano-sh:master May 26, 2026
6 checks passed


		We use [Docusaurus](https://docusaurus.io/) to format and generate our website, and [Netlify](https://www.netlify.com/) to manage the deployment of the site. Docusaurus is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown (with YAML front matter), and Docusaurus wraps them up into a website.

		Please see [How to contribute](https://github.com/volcano-sh/website/blob/master/CODE_OF_CONDUCT.md) for instructions on how to contribute, if you are not familiar with the GitHub workflow.


		Please see [How to contribute](https://github.com/volcano-sh/website/blob/master/CODE_OF_CONDUCT.md) for instructions on how to contribute, if you are not familiar with the GitHub workflow.

		## Quickstart


		### Prepare

		Install [prometheus](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus) or [prometheus-adaptor](https://github.com/prometheus-community/helm- c harts/tree/main/charts/prometheus-adapter), and [prometheus-node-exporter](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-node-exporter), The real load of the node is exposed to the `Volcano descheduler` through node-exporter and prometheus.

Conversation

labdhiongithub7 commented Apr 21, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JesseStutler commented May 6, 2026

Uh oh!

volcano-sh-bot commented May 6, 2026

Uh oh!

labdhiongithub7 commented May 6, 2026

Uh oh!

JesseStutler commented May 9, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JesseStutler left a comment

Choose a reason for hiding this comment

Uh oh!

JesseStutler May 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

labdhiongithub7 commented May 9, 2026

Uh oh!

labdhiongithub7 commented May 9, 2026

Uh oh!

labdhiongithub7 commented May 9, 2026

Uh oh!

JesseStutler commented May 14, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

labdhiongithub7 May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JesseStutler commented May 14, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

labdhiongithub7 May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

labdhiongithub7 commented May 14, 2026

Uh oh!

de6p left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JesseStutler May 9, 2026 •

edited

Loading

labdhiongithub7 May 14, 2026 •

edited

Loading

labdhiongithub7 May 14, 2026 •

edited

Loading