This is an automated email from the ASF dual-hosted git repository.
capistrant pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git
The following commit(s) were added to refs/heads/master by this push:
new e7eb0ea2ff5 docs: update readme for docusaurus 3 (#17969)
e7eb0ea2ff5 is described below
commit e7eb0ea2ff5087f22cf572e48fede7346fd1936f
Author: 317brian <[email protected]>
AuthorDate: Thu May 8 07:14:48 2025 -0700
docs: update readme for docusaurus 3 (#17969)
---
README.md | 4 +++-
website/README.md | 14 ++++++++------
website/package.json | 3 ++-
3 files changed, 13 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index b4b0e99afa9..ee54bc61cd0 100644
--- a/README.md
+++ b/README.md
@@ -87,10 +87,12 @@ 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 16.14 or higher and to install
Docusaurus 2 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 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.
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.
+For more information, see the [README in the `./website`
directory](./website/README.md).
+
### Community
Visit the official project [community](https://druid.apache.org/community/)
page to read about getting involved in contributing to Apache Druid, and how we
help one another use and operate Druid.
diff --git a/website/README.md b/website/README.md
index 2f4a99c693e..801081f1f46 100644
--- a/website/README.md
+++ b/website/README.md
@@ -23,14 +23,16 @@ This website was created with [Docusaurus
3](https://docusaurus.io/).
To view documentation run:
-`npm install`
+`yarn install`
Then run:
-`npm start`
+`yarn start`
The current version of the web site appears in your browser. Edit pages with
-your favorite editor. Refresh the web page after each edit to review your
changes.
+your favorite editor. The page should automatically refresh. If you need to
clear the build cache for some reason, use `yarn clear`.
+
+NPM is also supported, but Docusaurus recommends `yarn`.
## Dependencies
@@ -57,9 +59,9 @@ creating links to files of the same version on GitHub.
The variables are not replaced when running the web site locally using the
`start` command above. They're replaced as part of the process that copies the
docs to `apache/druid-website-src/`.
-## Spellcheck
+## Tests
-Please run a spellcheck before issuing a pull request to avoid a build failure
+Please run a spellcheck and link check before issuing a pull request to avoid
a build failure
due to spelling issues. Run:
```bash
@@ -69,4 +71,4 @@ npm run spellcheck
If you introduce new (correctly spelled) project names or technical terms, add
them to the dictionary in the `.spelling` file in this directory. Also, terms
-enclosed in backticks are not spell checked. Example: \``symbolName`\`
+enclosed in backticks are not spell checked. Example: \``symbolName`\`
\ No newline at end of file
diff --git a/website/package.json b/website/package.json
index e0e7f18e89f..7258989dd79 100644
--- a/website/package.json
+++ b/website/package.json
@@ -13,7 +13,8 @@
"spellcheck": "mdspell --en-us --ignore-numbers --report '../docs/**/*.md'
|| (./script/notify-spellcheck-issues && false)",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
- "docusaurus": "docusaurus"
+ "docusaurus": "docusaurus",
+ "clear": "docusaurus clear"
},
"engines": {
"node": ">=18.0"
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
