You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by vi...@apache.org on 2024/03/14 09:16:06 UTC
(pulsar-site) branch main updated: Update prerequisites for preview.sh: corepack is required (#845)
This is an automated email from the ASF dual-hosted git repository.
visortelle pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 0fea6dbefd50 Update prerequisites for preview.sh: corepack is required (#845)
0fea6dbefd50 is described below
commit 0fea6dbefd50344bc63d50c95657050badc37262
Author: Lari Hotari <lh...@users.noreply.github.com>
AuthorDate: Thu Mar 14 02:16:00 2024 -0700
Update prerequisites for preview.sh: corepack is required (#845)
* Update prerequisites for preview.sh: corepack is required
* Address review comments
---
contribute/document-preview.md | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/contribute/document-preview.md b/contribute/document-preview.md
index aef473115f7a..45c6ee399d6e 100644
--- a/contribute/document-preview.md
+++ b/contribute/document-preview.md
@@ -17,10 +17,17 @@ Pulsar documentation is built using [Docusaurus](https://docusaurus.io/). To pre
To verify docs are built correctly before submitting a contribution, you should set up your local environment to build and display the docs locally.
-* Node >= 16.14
-* Yarn >= 1.5
+* Node >= 20.0.0 (latest LTS recommended)
+* Corepack enabled (`corepack enable`)
* Although you can use Linux, macOS, or Windows to build locally the Pulsar documentation, macOS is the preferred build environment as it offers the most complete support for documentation building.
+Installing prerequisites with [homebrew](https://brew.sh/) on MacOS or Linux:
+
+```shell
+brew install node
+corepack enable
+```
+
### Preview changes
Pulsar website changes refer to all the changes made to the Pulsar website, including but not limited to the following pages: