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 · 2026-06-12T13:39:42Z

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

EDIT: Now they are working.

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?

PDavid · 2026-06-15T07:12:07Z

Many thanks, now the RAT check is successful locally and I can also see that since you resolved the conflicts the GitHub action checks are scheduled. (A committer has to approve it so that it runs.) 🚀

`overrides` will need to be removed later once the deps support the newer version of fixed esbuild

anmolnar

lgtm.

anmolnar · 2026-06-18T13:53:25Z

@yuriipalam Have you finished this patch?
I restarted the failing CI builds.

yuriipalam · 2026-06-18T14:49:59Z

@yuriipalam Have you finished this patch? I restarted the failing CI builds.

Yes, I have finished it. The CI check didn't seem to be related to my changes.

There were just some conflicts that I had to resolve, and I also fixed fresh CVEs as well.

tisonkun

Rest LGTM. We can move forward.

tisonkun · 2026-06-18T17:27:13Z

How does this data file get generated? I noticed that this is outdated.

For HBase and Phoenix this file was generated from the respective parts from root pom.xml on build time. For that reason this developers.json was not checked into the git repo and ignored. Is this different here @yuriipalam or should this be the same?

Here it's not generated from pom.xml. I took the data from the current website.
I just checked and probably it should be generated from it, since we have a list of developers there. I didn't notice it.
I can do it later as a separate patch. Thanks!

tisonkun · 2026-06-18T17:28:15Z

Seems to be outdated. Do we still maintain this channel? If not, we may remove this page later.

I don't really know, I just moved all the content we had. It's easy to remove if we need to.

anmolnar · 2026-06-18T18:07:13Z

@yuriipalam Please look at the comments on the following Jira ticket and modify the Security page accordingly:
https://issues.apache.org/jira/browse/ZOOKEEPER-5050

Thanks!

ppkarwasz · 2026-06-18T19:44:36Z

+
+The Apache Software Foundation takes security issues very seriously. Due to the infrastructure nature of the Apache ZooKeeper project specifically, we haven't had many reports over time, but it doesn't mean that we haven't had concerns over some bugs and vulnerabilities. If you have any concern or believe you have uncovered a vulnerability, we suggest that you get in touch via the e-mail address [security@zookeeper.apache.org](mailto:security@zookeeper.apache.org?Subject=[SECURITY]%20My%20security%20issue). In the message, try to provide a description of the issue and ideally a way of reproducing it. Note that this security address should be used only for undisclosed vulnerabilities. Dealing with known issues should be handled regularly via jira and the mailing lists. **Please report any security problems to the project security address before disclosing it publicly.**
+
+The ASF Security team maintains a page with a description of how vulnerabilities are handled, check their [Web page](https://www.apache.org/security/) for more information.


A small suggestion: consider linking to https://security.apache.org/report/ instead of https://www.apache.org/security/.

The /report/ page routes reporters to the appropriate channel up front. That keeps the wrong reports out of
security@zookeeper.apache.org. For instance, scanner output claiming that a ZooKeeper distribution bundles third-party dependencies with known CVEs should go to a public channel, not the private security address.

While we are here: as I noted in ZOOKEEPER-5050, it would be very useful if this page (or a subpage) carried a security/threat model summarizing ZooKeeper's security assumptions and guarantees. To get the ball rolling, I had an LLM draft one from the existing documentation: https://gist.github.com/ppkarwasz/f5be1b5c0182fe665252101c5f24d39f

The draft is not finished. It contains a set of open questions that need maintainer answers before it is complete, and an agent can ask those and fold the answers back into the document. I personally find this document's structure very convenient for triaging incoming reports, but the published form might (and probably should) be more narrative, along the lines of the Logging Services threat model or the Airflow security model.

Docs have been updated. PTAL @ppkarwasz

symat

LGTM, nice work!

ppkarwasz

Looks good to me! 💯

Thanks!

tisonkun · 2026-06-20T16:19:26Z

I have two comments above. They are not blockers but would expect for some replies :D

yuriipalam · 2026-06-22T07:57:44Z

@tisonkun thanks, I replied!

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 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

yuriipalam added 6 commits June 15, 2026 13:00

Fix search issue

166bc27

Fix CVEs

9399dd1

`overrides` will need to be removed later once the deps support the newer version of fixed esbuild

WIP

d4cdac0

Disable future flags for now

6ec295b

WIP

2adb71b

Redirect old URLs to new

74bf250

anmolnar approved these changes Jun 15, 2026

View reviewed changes

yuriipalam added 4 commits June 16, 2026 13:05

Merge branch 'master' into ZOOKEEPER-5020

4ac2334

Fix lint

f6ba120

Fix lint

0d7a771

Fix CVEs

91240ee

tisonkun approved these changes Jun 18, 2026

View reviewed changes

tisonkun reviewed Jun 18, 2026

View reviewed changes

ppkarwasz reviewed Jun 18, 2026

View reviewed changes

symat approved these changes Jun 19, 2026

View reviewed changes

Add request security content

d73e801

ppkarwasz approved these changes Jun 19, 2026

View reviewed changes

anmolnar merged commit 7e608ac into apache:master Jun 20, 2026
21 of 22 checks passed


		The Apache Software Foundation takes security issues very seriously. Due to the infrastructure nature of the Apache ZooKeeper project specifically, we haven't had many reports over time, but it doesn't mean that we haven't had concerns over some bugs and vulnerabilities. If you have any concern or believe you have uncovered a vulnerability, we suggest that you get in touch via the e-mail address [security@zookeeper.apache.org](mailto:security@zookeeper.apache.org?Subject=[SECURITY]%20My%20security%20issue). In the message, try to provide a description of the issue and ideally a way of reproducing it. Note that this security address should be used only for undisclosed vulnerabilities. Dealing with known issues should be handled regularly via jira and the mailing lists. Please report any security problems to the project security address before disclosing it publicly.

		The ASF Security team maintains a page with a description of how vulnerabilities are handled, check their [Web page](https://www.apache.org/security/) for more information.

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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 commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yuriipalam commented Jun 12, 2026

Uh oh!

PDavid commented Jun 15, 2026

Uh oh!

anmolnar left a comment

Choose a reason for hiding this comment

Uh oh!

anmolnar commented Jun 18, 2026

Uh oh!

yuriipalam commented Jun 18, 2026

Uh oh!

tisonkun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yuriipalam Jun 22, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anmolnar commented Jun 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

symat left a comment

Choose a reason for hiding this comment

Uh oh!

ppkarwasz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tisonkun commented Jun 20, 2026

Uh oh!

yuriipalam commented Jun 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

yuriipalam commented Apr 20, 2026 •

edited

Loading

PDavid Apr 27, 2026 •

edited

Loading

PDavid commented Jun 12, 2026 •

edited

Loading

yuriipalam Jun 22, 2026 •

edited

Loading