Skip to content

feat: migrate website from Hugo to Docusaurus#458

Open
KushguptaPST wants to merge 1 commit intovolcano-sh:masterfrom
KushguptaPST:feat-docusaurus-migration
Open

feat: migrate website from Hugo to Docusaurus#458
KushguptaPST wants to merge 1 commit intovolcano-sh:masterfrom
KushguptaPST:feat-docusaurus-migration

Conversation

@KushguptaPST
Copy link

Hi team,

This PR migrates the Volcano website from Hugo to Docusaurus. The goal is to make our documentation easier to maintain, customize, and contribute to, while taking advantage of Docusaurus’ React-based architecture, MDX support, and plugin ecosystem.

fixes #455

What’s changed
Hugo → Docusaurus

Initialized a new Docusaurus (v3.x) project.

Removed legacy Hugo setup.

Original Hugo content was backed up locally during migration (hugo_backup/) but is excluded from the repo to keep things clean.

Content migration
.Documentation moved from content/en/docs → docs/
.Blog posts moved from content/en/blog → blog/
.Static assets (images, logos, etc.) moved to static/

MDX compatibility fixes
.To ensure a clean Docusaurus build, several Hugo-specific and legacy Markdown issues were resolved:
.Replaced Hugo shortcodes with standard Markdown/MDX syntax.
.Fixed invalid or legacy HTML (unclosed tags, unquoted attributes, improper nesting).
.Converted inline HTML styles to MDX-compatible JSX where needed.
.Escaped mathematical operators (<, <=) that conflicted with the MDX parser.

Verification
.The site builds successfully with npm run build.
.You can preview locally using npm start.

Notes:
.This PR focuses on stabilizing the English content first. Other languages (e.g., Chinese) can be handled in a follow-up.
.There are some non-blocking warnings (broken links, git history) in the build output, but they do not affect the build.

@volcano-sh-bot
Copy link
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 jessestutler 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 Jan 30, 2026
@gemini-code-assist
Copy link

Summary of Changes

Hello @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 represents a significant architectural shift for the project's website, transitioning from a Hugo-based static site to a Docusaurus-powered platform. This migration aims to enhance the overall developer experience for maintaining and contributing to the documentation and blog, leveraging Docusaurus's modern features like React components and MDX support for improved flexibility and scalability.

Highlights

  • Website Platform Migration: The website has been fully migrated from the Hugo static site generator to Docusaurus v3.x, involving a complete overhaul of the underlying framework and content management system.
  • Content Restructuring and Compatibility: Existing documentation and blog posts have been moved to Docusaurus-standard directories (e.g., 'content/en/blog' to 'blog/') and adapted for MDX compatibility, including replacing Hugo shortcodes with standard Markdown/MDX syntax, fixing invalid HTML, and escaping problematic characters.
  • Removal of Legacy Assets: All Hugo-specific configuration files, custom CSS, JavaScript, and other related assets have been removed, streamlining the repository and eliminating outdated dependencies.
  • Updated Development Workflow: The project's README.md has been updated with new instructions for installing, developing, and building the website using Docusaurus's npm-based commands.

🧠 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.

Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/fossa.yml
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@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 represents a significant and well-executed migration of the Volcano website from Hugo to Docusaurus. The changes correctly handle the transition of content, including converting Hugo-specific shortcodes to MDX-compatible syntax and updating project configuration files like .gitignore and README.md.

My review focuses on a few key areas for improvement:

  • Project Governance Files: The removal of the LICENSE and CODE_OF_CONDUCT.md files is a major concern that needs to be addressed to maintain legal compliance and community health.
  • HTML Best Practices: Several markdown files contain obsolete HTML tags (<center>, <font>) that should be replaced with modern CSS-based styling for better maintainability and standards compliance.
  • Content Parity: As noted in the PR description, the Chinese documentation has been removed. While this is planned for a follow-up, it's a significant temporary regression in content availability.

Overall, this is a great step forward for the project's documentation platform. Addressing the identified issues will help ensure the new site is robust, maintainable, and compliant.

@@ -1,201 +0,0 @@
Apache License

Choose a reason for hiding this comment

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

critical

The LICENSE file has been removed. This is a critical file for any open-source project. It seems it was not added back as part of the Docusaurus migration. Please ensure an Apache 2.0 license file is present at the root of the repository to maintain legal compliance.

@@ -1,76 +0,0 @@
# Contributor Covenant Code of Conduct

Choose a reason for hiding this comment

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

medium

The CODE_OF_CONDUCT.md file was removed. A Code of Conduct is essential for fostering a healthy and welcoming community. Please add it back, perhaps in a location that Docusaurus recognizes, or create a new one based on a standard template like the Contributor Covenant.


### Join Volcano at KubeCon + CloudNativeCon Europe, 19-22 March in Paris!
<center> {{<figure library="1" src="./kubecon/2024-paris.png">}}</center>
<center> <img src="/kubecon/2024-paris.png" /></center>

Choose a reason for hiding this comment

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

medium

The <center> tag is obsolete in HTML5 and not recommended for styling. For centering content, please use CSS styling, for example by wrapping the content in a <div> with an inline style. This will improve maintainability and adhere to modern web standards. This issue also appears in other migrated blog posts.

Suggested change
<center> <img src="/kubecon/2024-paris.png" /></center>
<div style={{textAlign: 'center'}}><img src="/kubecon/2024-paris.png" /></div>

+++

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

Choose a reason for hiding this comment

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

medium

The <font> tag is obsolete in HTML5 and should be avoided for styling. Please use modern CSS approaches, such as <span> elements with inline styles or CSS classes. This improves maintainability and follows web standards. This tag is used multiple times in this file.

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>
<span style={{fontFamily: "Arial", fontSize: "large"}}> 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.</span>

@KushguptaPST KushguptaPST force-pushed the feat-docusaurus-migration branch 2 times, most recently from 981b800 to 517fe7d Compare January 30, 2026 17:46
@KushguptaPST
Copy link
Author

Hi @JesseStutler,
Requesting review from the maintainers.
Happy to make any changes if needed. Thanks!

@codeEvolveZenith345
Copy link
Contributor

@KushguptaPST Please do not spam maintainers to review a PR that is broken!
image

@codeEvolveZenith345
Copy link
Contributor

@KushguptaPST have you even built it before pushing???

image

@KushguptaPST KushguptaPST force-pushed the feat-docusaurus-migration branch from 517fe7d to 50105e5 Compare January 31, 2026 04:52
@KushguptaPST
Copy link
Author

KushguptaPST commented Jan 31, 2026

@codeEvolveZenith345 sorry for that issue,
Now you can check everything is working fine ....

Screenshot 2026-01-31 at 10 25 44 AM

@KushguptaPST KushguptaPST force-pushed the feat-docusaurus-migration branch from 50105e5 to e92f796 Compare January 31, 2026 05:55
Migrate entire site from Hugo to Docusaurus structure. Includes content migration, MDX fixes, and configuration.

Signed-off-by: KushguptaPST <kushg0082@gmail.com>
@KushguptaPST KushguptaPST force-pushed the feat-docusaurus-migration branch from e92f796 to 017fa19 Compare January 31, 2026 11:31
@codeEvolveZenith345
Copy link
Contributor

@KushguptaPST Do you even know what you are pushing? I have a strong intuition it is done by AI end-to-end!

image

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

Labels

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.

feat: Migrating hugo to docusaurus

3 participants