Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ See the [latest documentation](https://druid.apache.org/docs/latest/) for the do

Make documentation and tutorials updates in [`/docs`](https://github.com/apache/druid/tree/master/docs) using [Markdown](https://www.markdownguide.org/) or extended Markdown [(MDX)](https://mdxjs.com/). Then, open a pull request.

To build the site locally, you need Node 18 or higher and to install Docusaurus 3 with `npm|yarn install` in the `website` directory. Then you can run `npm|yarn start` to launch a local build of the docs.
To build the site locally, you need Node 22 or higher and to install Docusaurus 3 with `npm|yarn install` in the `website` directory. Then you can run `npm|yarn start` to launch a local dev preview of the docs.

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.

[P2] Keep the documented Node requirement in sync with build tooling

The README now says the docs require Node 22 or higher, but the actual website metadata and automation still point at older runtimes: website/package.json allows >=18.0 and Volta pins 18.20.7, while .github/scripts/web-checks.sh installs the web-console Maven-configured Node 20.9.0 before running the docs build. If Docusaurus 3.10 now requires Node 22 for this site, contributors using Volta and the existing web checks will still run unsupported Node versions; otherwise the new README requirement is misleading. Please update the package metadata and CI/tooling Node version, or keep the README aligned with the supported runtime.


If you're looking to update non-doc pages like Use Cases, those files are in the [`druid-website-src`](https://github.com/apache/druid-website-src/tree/master) repo.

Expand Down
11 changes: 9 additions & 2 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,11 @@ module.exports={
"disableHeaderTitle": true
},
"onBrokenLinks": "log",
"onBrokenMarkdownLinks": "throw",
markdown: {
mermaid: true,
hooks: {
onBrokenMarkdownLinks: "throw"
}
},
"presets": [
[
Expand Down Expand Up @@ -160,5 +162,10 @@ module.exports={
"src": "img/favicon.png"
}
},
}
},
future: {
v4: {
fasterByDefault: true,
removeLegacyPostBuildHeadAttribute: true
}}
}
Loading
Loading