Skip to content

Commit 7e608ac

Browse files
authored
ZOOKEEPER-5020: Improve ZooKeeper website
Reviewers: PDavid, anmolnar, tisonkun, symat, ppkarwasz Author: yuriipalam Closes #2373 from yuriipalam/ZOOKEEPER-5020
1 parent 9dd41cd commit 7e608ac

261 files changed

Lines changed: 43207 additions & 19794 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/website.yaml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
name: Website
19+
20+
on:
21+
push:
22+
branches: [ '*' ]
23+
pull_request:
24+
branches: [ '*' ]
25+
26+
permissions:
27+
contents: read
28+
29+
jobs:
30+
site:
31+
name: website-site
32+
timeout-minutes: 120
33+
runs-on: ubuntu-latest
34+
steps:
35+
- uses: actions/checkout@v6
36+
- name: Set up JDK 11
37+
uses: actions/setup-java@v5
38+
with:
39+
java-version: 11
40+
distribution: temurin
41+
cache: 'maven'
42+
- name: Set up Node.js 22
43+
uses: actions/setup-node@v5
44+
with:
45+
node-version: 22
46+
cache: 'npm'
47+
cache-dependency-path: zookeeper-website/package-lock.json
48+
- name: Show the first log message
49+
run: git log -n1
50+
- name: Install website npm dependencies
51+
working-directory: zookeeper-website
52+
run: npm ci
53+
- name: Install Playwright browsers and system dependencies
54+
working-directory: zookeeper-website
55+
run: npx playwright install --with-deps
56+
- name: Build website with Maven site
57+
run: mvn -B -V -e -ntp "-Dstyle.color=always" -pl zookeeper-website site
58+
env:
59+
MAVEN_OPTS: -Djansi.force=true
60+
- name: Upload website Playwright report
61+
if: ${{ failure() }}
62+
uses: actions/upload-artifact@v7
63+
with:
64+
name: website-playwright-report
65+
path: zookeeper-website/playwright-report/
66+
if-no-files-found: ignore
67+
- name: Upload website test results
68+
if: ${{ failure() }}
69+
uses: actions/upload-artifact@v7
70+
with:
71+
name: website-test-results
72+
path: zookeeper-website/test-results/
73+
if-no-files-found: ignore

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
</licenses>
5858

5959
<modules>
60-
<module>zookeeper-docs</module>
60+
<module>zookeeper-website</module>
6161
<module>zookeeper-jute</module>
6262
<module>zookeeper-server</module>
6363
<module>zookeeper-metrics-providers</module>

zookeeper-assembly/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<dependencies>
5151
<dependency>
5252
<groupId>org.apache.zookeeper</groupId>
53-
<artifactId>zookeeper-docs</artifactId>
53+
<artifactId>zookeeper-website</artifactId>
5454
<version>${project.version}</version>
5555
<type>pom</type>
5656
</dependency>

zookeeper-assembly/src/main/assembly/bin-package.xml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<excludes>
3838
<exclude>org.apache.zookeeper:zookeeper-recipes</exclude>
3939
<exclude>org.apache.zookeeper:zookeeper-client</exclude>
40-
<exclude>org.apache.zookeeper:zookeeper-docs</exclude>
40+
<exclude>org.apache.zookeeper:zookeeper-website</exclude>
4141
</excludes>
4242
<useProjectArtifact>false</useProjectArtifact>
4343
<useTransitiveDependencies>true</useTransitiveDependencies>
@@ -49,13 +49,6 @@
4949
</dependencySets>
5050

5151
<fileSets>
52-
<fileSet>
53-
<!-- ZooKeeper generated documents -->
54-
<directory>${project.basedir}/../zookeeper-docs/target/html</directory>
55-
<outputDirectory>docs</outputDirectory>
56-
<fileMode>${rw.file.permission}</fileMode>
57-
<directoryMode>${rwx.file.permission}</directoryMode>
58-
</fileSet>
5952
<fileSet>
6053
<!-- ZooKeeper jute generated api document -->
6154
<directory>${project.basedir}/../zookeeper-jute/target/apidocs</directory>

zookeeper-docs/pom.xml

Lines changed: 0 additions & 64 deletions
This file was deleted.

zookeeper-docs/src/main/resources/markdown/html/footer.html

Lines changed: 0 additions & 18 deletions
This file was deleted.

zookeeper-docs/src/main/resources/markdown/html/header.html

Lines changed: 0 additions & 149 deletions
This file was deleted.

0 commit comments

Comments
 (0)