Skip to content

chore(docusaurus): upgrade to v3.10.1 and migrate markdown hooks #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vanshika2720 wants to merge 1 commit into
base: master
Choose a base branch
from
+527 −1,290
Open

chore(docusaurus): upgrade to v3.10.1 and migrate markdown hooks #533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ const config = {
title: "Volcano",
tagline: "Cloud native batch scheduling system",


future: {
v4: true,
// v4 turns on fasterByDefault, which requires the @docusaurus/faster
// package. We don't depend on it yet, so this must stay explicit.
faster: false,

@hajnalmt hajnalmt Jul 10, 2026

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.

Is there an actual reason to set this if we don't enable it?

@vanshika2720 vanshika2720 Jul 10, 2026

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.

@hajnalmt I tested removing it after your comment to verify whether it was still needed. The build fails without it because this repository already has future.v4: true, and in Docusaurus 3.10.x that enables the faster pipeline by default. Since this project doesn't include @docusaurus/faster as a dependency, the build errors unless future.faster is explicitly set to false.

So I kept the flag to preserve the current build behavior and added a short comment in the config explaining why it's there. This keeps the upgrade focused on the Docusaurus version bump without enabling the faster pipeline.

@hajnalmt hajnalmt Jul 16, 2026

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.

Agh thanks for the clarification, I understand now.

},

url: "https://volcano.sh",
Expand Down Expand Up @@ -45,7 +47,12 @@ const config = {
projectName: "website",

onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
markdown: {
format: "detect",
hooks: {
onBrokenMarkdownLinks: "throw",
},
},
Comment thread
vanshika2720 marked this conversation as resolved.

i18n: {
defaultLocale: "en",
Expand Down Expand Up @@ -85,7 +92,7 @@ const config = {
"classic",
{
docs: {
sidebarPath: require.resolve('./sidebar.js'),
sidebarPath: require.resolve("./sidebar.js"),
showLastUpdateTime: true,
showLastUpdateAuthor: false,
editUrl: "https://github.com/volcano-sh/website/tree/master/",
Expand Down Expand Up @@ -191,4 +198,4 @@ const config = {
},
};

export default config;
export default config;
Loading