FrankChen021 commented on code in PR #19522:
URL: https://github.com/apache/druid/pull/19522#discussion_r3348718740
##########
website/package.json:
##########
@@ -24,20 +24,21 @@
"npm": "10.8.2"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "3.7.0",
- "@docusaurus/types": "3.7.0",
+ "@docusaurus/module-type-aliases": "3.10.1",
+ "@docusaurus/types": "3.10.1",
"markdown-spellcheck": "^1.3.1",
"postcss": "^8.4.24",
"sass": "^1.62.1"
},
"dependencies": {
- "@docusaurus/core": "^3.7.0",
- "@docusaurus/plugin-client-redirects": "^3.7.0",
- "@docusaurus/preset-classic": "^3.7.0",
- "@docusaurus/theme-mermaid": "^3.7.0",
+ "@docusaurus/core": "^3.10.1",
Review Comment:
[P2] Regenerate the website lockfile with the Docusaurus upgrade
This PR updates the website dependencies to Docusaurus 3.10.1 and adds new
packages, but website/package-lock.json is unchanged: its root entry still
declares the old ^3.7.0 Docusaurus ranges and the resolved graph still pins
3.7.0 while missing the new direct dependency entries. A clean reproducible
install such as npm ci will reject the mismatch, and lockfile-based consumers
will not be testing the dependency graph this PR intends to ship. Please
regenerate and commit website/package-lock.json with the same package manager
used for the website.
##########
README.md:
##########
@@ -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.
Review Comment:
[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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
