Skip to content

ZOOKEEPER-5020: Improve ZooKeeper website#2373

Open
yuriipalam wants to merge 10 commits intoapache:masterfrom
yuriipalam:ZOOKEEPER-5020
Open

ZOOKEEPER-5020: Improve ZooKeeper website#2373
yuriipalam wants to merge 10 commits intoapache:masterfrom
yuriipalam:ZOOKEEPER-5020

Conversation

@yuriipalam
Copy link
Copy Markdown

@yuriipalam yuriipalam commented Apr 20, 2026

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.

@yuriipalam yuriipalam marked this pull request as ready for review April 20, 2026 14:07
@eolivelli
Copy link
Copy Markdown
Contributor

this is great, please have a conversation on [email protected] 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

@anmolnar
Copy link
Copy Markdown
Contributor

this is great, please have a conversation on [email protected] 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.

Copy link
Copy Markdown
Contributor

@PDavid PDavid Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

@PDavid PDavid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

Comment on lines +368 to +370
## quit

Quit the CLI.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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_ :
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants