ZOOKEEPER-5020: Improve ZooKeeper website by yuriipalam · Pull Request #2373 · apache/zookeeper

yuriipalam · 2026-04-20T13:31:02Z

This is a draft PR of the new ZooKeeper website. The documentation can be found in the README.md file under the zookeeper-website directory. The zookeeper-docs directory is removed.

This PR might have more updates in the near future.

There is currently ongoing process of CI/CD integration into the Zookeeper repository. We're considering moving the released docs to another branch and just merge it with the website at a build time, since there's no point to pull a huge archive (1 GB) whenever you want to clone the repo. This discussion is currently ongoing, this app doesn't contain the released docs.

Website preview: https://zookeeper-website.vercel.app/

Previously, the master branch stored docs sources only of the current version, and the website branch had the landing page source code plus the released docs. Currently, the master branch has the code of both documentation and landing page, it's all one app now.

eolivelli · 2026-04-23T13:05:12Z

this is great, please have a conversation on dev@zookeeper.apache.org about the release process

this is our current release process and it involves updating the website:
https://cwiki.apache.org/confluence/display/ZOOKEEPER/HowToRelease+using+maven+release+plugin

…-website module

anmolnar · 2026-04-24T13:44:34Z

this is great, please have a conversation on dev@zookeeper.apache.org about the release process

this is our current release process and it involves updating the website: https://cwiki.apache.org/confluence/display/ZOOKEEPER/HowToRelease+using+maven+release+plugin

Hi @eolivelli ,

There's already a discussion thread on dev@ with subject "[DISCUSS] The New ZooKeeper Website".
Feel free to chime in.

PDavid · 2026-04-27T08:09:58Z

For installing Playwright in GH Actions you might find this useful:
https://playwright.dev/docs/ci-intro#setting-up-github-actions

PDavid

Many thanks, impressive work! 👍 I really like the new website.

I just found that we may miss some recently made updates, please see below.

PDavid · 2026-04-27T12:21:11Z

+## quit
+
+Quit the CLI.


I think there we re some updates to this section under https://github.com/apache/zookeeper/pull/2358/changes not so long ago.

PDavid · 2026-04-27T12:22:20Z

+  enable Prometheus.io exporter.
+- _metricsProvider.httpHost_ :
+  **New in 3.8.0:** Prometheus.io exporter will start a Jetty server and listen this address, default is "0.0.0.0"
+- _metricsProvider.httpPort_ :


There were some updates to this section in https://github.com/apache/zookeeper/pull/2360/changes not so long ago.

PDavid · 2026-04-27T12:24:11Z

+metricsProvider.httpPort=7000
+metricsProvider.httpsPort=4443
+```
+


A new section was added here not so long ago, see: https://github.com/apache/zookeeper/pull/2360/changes#diff-ba1b80ad29e393353d4dde0f0895bc2425d0ddaa558f5f81f21f8b19ee1dbf0d

PDavid · 2026-04-27T12:29:32Z

+- _server_stats/srvr_ :
+  Server information.
+  Returns multiple fields giving a brief overview of server state.
+


I think we should add here shed_connections/shed which was added not so long ago:

https://github.com/apache/zookeeper/pull/2352/changes#diff-b23410aa2905e03ad9746e55d595b63d35ffdb8ea34083c75cabeb83366f324c

yuriipalam · 2026-04-27T14:15:56Z

Thanks for your review @PDavid
I will apply the changes once everything else is done

yuriipalam · 2026-05-26T14:14:19Z

Everything seems to be done. The PR for changes in the asf-site branch is open, please take a look #2396

Once the final feedback is received, I will rebase the documentation changes.

In the discussion thread we decided to architect the website in the following way:

Store the released docs in the asf-site branch. This branch stores the build being served. For example, we already do this for HBase (though it's in a separate repo, which isn't the point here), but we don't have that many old versions there. This way we don't store heavy archives in the master branch, but it comes with a tradeoff. In the master branch, we have to maintain an array of all released versions, we got more than 50 of them. We need to show the list of all previously released docs on the website. To release a new version of ZooKeeper we have to open two PRs, one for master and another for asf-site. The flow is like this: we build master, then we store the last build in the asf-site branch as other released docs. In master, we update the released versions array, and the current version. Then push the changes.

PDavid

Many thanks Yurii! This looks good to me. 👍

I think what are pending before merging are:

resolving conflicts with base branch
add the missing doc updates which happened since on base branch

PDavid · 2026-06-12T13:18:41Z

Thanks for the detailed README. 👍

Sure, absolutely.

PDavid · 2026-06-12T13:38:55Z

It seems the rat check will be broken because of the sitemap.xml file the website builds:

$ mvn -Pfull-build apache-rat:check verify -DskipTests
...
[WARNING] Files with unapproved licenses:
  /home/ws1test3/projects/upstream/zookeeper/zookeeper-website/public/sitemap.xml
[INFO] ------------------------------------------------------------------------

...

INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  2.950 s
[INFO] Finished at: 2026-06-12T15:36:56+02:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.rat:apache-rat-plugin:0.15:check (default-cli) on project zookeeper-website: Too many files with unapproved license: 1 See RAT report in: /home/ws1test3/projects/upstream/zookeeper/zookeeper-website/target/rat.txt -> [Help 1]
[ERROR]

I guess sitemap.xml has to be excluded from rat check.

PDavid · 2026-06-12T13:39:42Z

Interestingly the GitHub Actions were not run on the latest changes. Maybe it would worth to squash the commits?

yuriipalam · 2026-06-12T14:34:52Z

Interestingly the GitHub Actions were not run on the latest changes. Maybe it would worth to squash the commits?

I can try that. Should I squash everything that we got on this branch into one commit?

ZOOKEEPER-5020: Improve ZooKeeper website

1a7bc1b

yuriipalam force-pushed the ZOOKEEPER-5020 branch from 146dc71 to 1a7bc1b Compare April 20, 2026 13:33

yuriipalam marked this pull request as ready for review April 20, 2026 14:07

yuriipalam added 7 commits April 20, 2026 16:54

Fix build

06217d0

WIP

37a6f19

Fix CI issues

78d5f71

Add GitHub Actions workflow for website build

ebc8b5c

Add sitemap generation, robots.txt, and HTTP cache headers

a0729bc

Fix CVEs

0e0ecb2

Fix lint

f9f5a8c

Move RAT plugin exclusions for .mdx files and robots.txt to zookeeper…

ff2606e

…-website module

PDavid reviewed Apr 27, 2026

View reviewed changes

Update CI

e368bfe

yuriipalam added 3 commits May 26, 2026 10:46

WIP

0724aa0

WIP

b454945

Update readme

e620fbb

WIP

53c2734

PDavid reviewed May 28, 2026

View reviewed changes

Comment thread zookeeper-website/app/pages/_docs/docs/index.tsx Outdated

yuriipalam added 7 commits May 28, 2026 17:44

WIP

5960eef

Update CI

2e5d73b

Centralize docs base path formatting

166ddc3

WIP

529b5ad

WIP

b732d1c

WIP

44a940c

WIP

0d98c40

yuriipalam added 15 commits June 3, 2026 15:53

WIP

3a834a5

WIP

ff5070b

WIP

1d207df

WIP

653f98b

WIP

53aa913

WIP

68eb559

WIP

56799e1

WIP

f26c796

WIP

bf7bf9e

WIP

81c7751

Improve publishing process

a7d43e1

WIP

c7b80bc

WIP

93d6b75

WIP

e261df2

Remove dockerfile

1cb7494

PDavid approved these changes Jun 12, 2026

View reviewed changes

yuriipalam added 4 commits June 12, 2026 16:37

Exclude sitemap from RAT check

46aa14c

Merge branch 'master' into ZOOKEEPER-5020

96147ee

Add missing content pieces

491e56a

Delete README

35732ea

Conversation

yuriipalam commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eolivelli commented Apr 23, 2026

Uh oh!

anmolnar commented Apr 24, 2026

Uh oh!

PDavid Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PDavid left a comment

Choose a reason for hiding this comment

Uh oh!

PDavid Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

PDavid Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

PDavid Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

PDavid Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

yuriipalam commented Apr 27, 2026

Uh oh!

yuriipalam commented May 26, 2026

Uh oh!

Uh oh!

PDavid left a comment

Choose a reason for hiding this comment

Uh oh!

PDavid Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

yuriipalam Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

PDavid commented Jun 12, 2026

Uh oh!

PDavid commented Jun 12, 2026

Uh oh!

yuriipalam commented Jun 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

yuriipalam commented Apr 20, 2026 •

edited

Loading

PDavid Apr 27, 2026 •

edited

Loading