You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: zookeeper-website/README.md
+21-8Lines changed: 21 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -386,7 +386,17 @@ Generated files are located under the `build/` directory.
386
386
387
387
### Maven Integration
388
388
389
-
The website is integrated with the Apache ZooKeeper Maven build system using the `frontend-maven-plugin`. The website is configured to build **only during site generation** (`mvn site`) and will not build during regular Maven lifecycle phases like `mvn clean install`.
389
+
The website is integrated into the Apache ZooKeeper Maven build through two POMs:
390
+
391
+
- The repository root `pom.xml` includes `zookeeper-website` as a Maven module.
392
+
-`zookeeper-website/pom.xml` owns the website-specific build and configures `frontend-maven-plugin`.
393
+
394
+
The frontend plugin is intentionally bound only to the Maven `site` lifecycle:
395
+
396
+
-`pre-site` installs Node.js/npm and runs `npm install`
397
+
-`site` runs the website CI command
398
+
399
+
Because of that, the website is built **only during site generation** (`mvn site`) and is skipped during regular Maven lifecycle phases such as `mvn clean install`.
390
400
391
401
#### When the Website Builds
392
402
@@ -404,7 +414,7 @@ The website will **NOT** build during regular commands like:
404
414
405
415
This keeps regular ZooKeeper builds fast while still allowing the website to be generated when needed.
406
416
407
-
#### What Gets Executed During `mvn site`
417
+
#### What the Website POM Does During `mvn site`
408
418
409
419
When you run `mvn site`, the website module automatically:
410
420
@@ -452,7 +462,7 @@ mvn clean install
452
462
**Build the Website:**
453
463
454
464
```bash
455
-
# From ZooKeeper root or zookeeper-website directory
465
+
# From ZooKeeper root directory
456
466
mvn site
457
467
```
458
468
@@ -470,18 +480,21 @@ This runs `npm run ci-skip-tests` for the website module.
470
480
**Build Website Only:**
471
481
472
482
```bash
473
-
# From zookeeper-website directory
483
+
# From ZooKeeper root directory
484
+
mvn -pl zookeeper-website site
485
+
486
+
# Or from the website module directory
474
487
cd zookeeper-website
475
-
mvn clean install
488
+
mvn site
476
489
```
477
490
478
491
**Skip Website Build:**
479
492
480
-
If you want to build ZooKeeper but skip the website:
493
+
If you are running the Maven `site` lifecycle but want to disable the website frontend build:
481
494
482
495
```bash
483
-
# From ZooKeeper root directory
484
-
mvn clean install -DskipSite
496
+
# From ZooKeeper root or zookeeper-website directory
0 commit comments