Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions .github/workflows/website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ jobs:
timeout-minutes: 120
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up JDK 25
- uses: actions/checkout@v7
- name: Set up JDK 11
uses: actions/setup-java@v5
with:
java-version: 25
distribution: temurin
cache: 'maven'
- name: Set up Node.js 22
uses: actions/setup-node@v5
uses: actions/setup-node@v6
with:
node-version: 22
cache: 'npm'
Expand All @@ -50,6 +50,11 @@ jobs:
- name: Install website npm dependencies
working-directory: zookeeper-website
run: npm ci
- name: Cache Playwright browsers
uses: actions/cache@v4
with:
path: ~/.cache/ms-playwright
key: playwright-${{ runner.os }}-${{ hashFiles('zookeeper-website/package-lock.json') }}
- name: Install Playwright browsers and system dependencies
working-directory: zookeeper-website
run: npx playwright install --with-deps
Expand Down
1 change: 0 additions & 1 deletion NOTICE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ These BSD licensed files:
./zookeeper-client/zookeeper-client-c/src/hashtable/hashtable_itr.c
./zookeeper-client/zookeeper-client-c/src/hashtable/hashtable_itr.h
./zookeeper-client/zookeeper-client-c/src/hashtable/hashtable_private.h
./zookeeper-docs/src/main/resources/markdown/skin/prototype.js

This Apache 2.0 licensed file:
./zookeeper-contrib/zookeeper-contrib-zooinspector/src/main/java/com/nitido/utils/toaster/Toaster.java
Expand Down
2 changes: 1 addition & 1 deletion conf/zoo_sample.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ clientPort=2181
# Be sure to read the maintenance section of the
# administrator guide before turning on autopurge.
#
# https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_maintenance
# https://zookeeper.apache.org/doc/current/admin-ops/administrators-guide/administration#maintenance
#
# The number of snapshots to retain in dataDir
#autopurge.snapRetainCount=3
Expand Down
3 changes: 0 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1094,9 +1094,6 @@
<exclude>.travis.yml</exclude>
<exclude>excludeFindBugsFilter.xml</exclude>
<exclude>README_packaging.md</exclude>
<exclude>src/main/resources/markdown/skin/*</exclude>
<exclude>src/main/resources/markdown/html/*</exclude>
<exclude>src/main/resources/markdown/images/*</exclude>
<exclude>**/src/test/resources/embedded/*.conf</exclude>
<!-- contrib -->
<exclude>**/JMX-RESOURCES</exclude>
Expand Down
8 changes: 5 additions & 3 deletions zookeeper-client/zookeeper-client-c/README
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ For the latest information about ZooKeeper, please visit our website at:
and our wiki, at:
https://cwiki.apache.org/confluence/display/ZOOKEEPER

Full documentation for this release can also be found in ../../docs/index.html
Full documentation for this release can also be found at:
https://zookeeper.apache.org/doc/current/

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'm not sure - but shouldn't all references be local given the doc relative to this reference is in this code base and should be used (could be updated as part of a change) rather than pointing to the release version on the website? Similar comment for all the relative -> absolute/web conversions in this commit.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I can make it local, but it's probably not going to work like it used to be. Currently we don't have some index.html that's a source and output at the same time. We got .mdx files and they are rendered by JS into html files at build time, so we don't have "ready" pages to be viewed right away anymore.



OVERVIEW
Expand All @@ -34,8 +35,9 @@ Sync and Async API.

INSTALLATION

Please refer to the "Installation" item under "C Binding" section in file
".../trunk/zookeeper-docs/src/main/resources/markdown/zookeeperProgrammers.md"
Please refer to the "Installation" item under "C Binding" in the
Programmer's Guide:
https://zookeeper.apache.org/doc/current/developer/programmers-guide/bindings#installation

EXAMPLE/SAMPLE C CLIENT SHELL

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ ${shared.header("ZooKeeper Browser > Tree > %s > %s" % (cluster['nice_name'], pa
</table>

<br />
<a target="_blank" rel="noopener noreferrer" href="http://zookeeper.apache.org/docs/current/zookeeperProgrammers.html#sc_zkStatStructure">Details on stat information.</a>
<a target="_blank" rel="noopener noreferrer" href="https://zookeeper.apache.org/doc/current/developer/programmers-guide/data-model#zookeeper-stat-structure">Details on stat information.</a>

${shared.footer()}

2 changes: 1 addition & 1 deletion zookeeper-contrib/zookeeper-contrib-monitoring/README
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,5 @@ Apache License 2.0 or later.
ZooKeeper 4letterwords Commands
-------------------------------

http://zookeeper.apache.org/docs/current/zookeeperAdmin.html#sc_zkCommands
https://zookeeper.apache.org/doc/current/admin-ops/administrators-guide/commands#the-four-letter-words

5 changes: 3 additions & 2 deletions zookeeper-recipes/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ some unit testing with both the c and java recipe code.
zkr_recipe-name_methodname
(eg. zkr_lock_lock in zookeeper-recipes-lock/src/c)

6) The various recipes are in ../docs/recipes.html or
../../docs/reciped.pdf. Also, this is not an exhaustive list by any chance.
6) The various recipes are documented at
https://zookeeper.apache.org/doc/current/developer/recipes
Also, this is not an exhaustive list by any chance.
Zookeeper is used (and can be used) for more than what we have listed in the docs.

7) To run the c tests in all the recipes,
Expand Down
2 changes: 1 addition & 1 deletion zookeeper-recipes/zookeeper-recipes-election/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
-->

1) This election interface recipe implements the leader election recipe
mentioned in ../../docs/recipes.[html,pdf].
documented at https://zookeeper.apache.org/doc/current/developer/recipes

2) To compile the leader election java recipe you can just run ant jar from
this directory.
Expand Down
2 changes: 1 addition & 1 deletion zookeeper-recipes/zookeeper-recipes-lock/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
-->

1) This lock interface recipe implements the lock recipe
mentioned in ../../docs/recipes.[html,pdf].
documented at https://zookeeper.apache.org/doc/current/developer/recipes

2) To compile the lock java recipe you can just run ant jar from
this directory. For compiling the c library go to zookeeper-client/zookeeper-client-c and read
Expand Down
2 changes: 1 addition & 1 deletion zookeeper-recipes/zookeeper-recipes-queue/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
-->

1) This queue interface recipe implements the queue recipe
mentioned in ../../../docs/recipes.[html,pdf].
documented at https://zookeeper.apache.org/doc/current/developer/recipes
A more detailed explanation is at http://www.cloudera.com/blog/2009/05/28/building-a-distributed-concurrent-queue-with-apache-zookeeper/

2) This recipe does not handle KeeperException.ConnectionLossException or ZCONNECTIONLOSS. It will only work correctly once ZOOKEEPER-22 https://issues.apache.org/jira/browse/ZOOKEEPER-22 is resolved.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1718,7 +1718,7 @@ public void delete(final String path, int version) throws InterruptedException,
* Note: The maximum allowable size of all of the data arrays in all of
* the setData operations in this single request is typically 1 MB
* (1,048,576 bytes). This limit is specified on the server via
* <a href="http://zookeeper.apache.org/doc/current/zookeeperAdmin.html#Unsafe+Options">jute.maxbuffer</a>.
* <a href="https://zookeeper.apache.org/doc/current/admin-ops/administrators-guide/configuration-parameters#unsafe-options">jute.maxbuffer</a>.
* Requests larger than this will cause a KeeperException to be
* thrown.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
* See the "Pluggable ZooKeeper authentication" section of the
* "Zookeeper Programmer's Guide" for general details of implementing an
* authentication plugin. e.g.
* http://zookeeper.apache.org/doc/current/zookeeperProgrammers.html#sc_ZooKeeperPluggableAuthentication
* https://zookeeper.apache.org/doc/current/developer/programmers-guide/pluggable-authentication
*
* This class looks for a numeric "key" under the /key node.
* Authorization is granted if the user passes in as authorization a number
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,108 +33,108 @@
public class FourLetterCommands {

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int confCmd = ByteBuffer.wrap("conf".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int consCmd = ByteBuffer.wrap("cons".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int crstCmd = ByteBuffer.wrap("crst".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int dirsCmd = ByteBuffer.wrap("dirs".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int dumpCmd = ByteBuffer.wrap("dump".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int enviCmd = ByteBuffer.wrap("envi".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int getTraceMaskCmd = ByteBuffer.wrap("gtmk".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int ruokCmd = ByteBuffer.wrap("ruok".getBytes()).getInt();
/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int setTraceMaskCmd = ByteBuffer.wrap("stmk".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int srvrCmd = ByteBuffer.wrap("srvr".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int srstCmd = ByteBuffer.wrap("srst".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int statCmd = ByteBuffer.wrap("stat".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int wchcCmd = ByteBuffer.wrap("wchc".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int wchpCmd = ByteBuffer.wrap("wchp".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int wchsCmd = ByteBuffer.wrap("wchs".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int mntrCmd = ByteBuffer.wrap("mntr".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
public static final int isroCmd = ByteBuffer.wrap("isro".getBytes()).getInt();

/*
* See <a href="{@docRoot}/../../../docs/zookeeperAdmin.html#sc_zkCommands">
* See <a href="{@docRoot}/../../admin-ops/administrators-guide/commands#the-four-letter-words">
* Zk Admin</a>. this link is for all the commands.
*/
protected static final int hashCmd = ByteBuffer.wrap("hash".getBytes()).getInt();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@
* configuration information. This file is a Properties file, so keys and
* values are separated by equals (=) and the key/value pairs are separated
* by new lines. The following is a general summary of keys used in the
* configuration file. For full details on this see the documentation in
* docs/index.html
* configuration file. For full details see the
* <a href="https://zookeeper.apache.org/doc/current/admin-ops/administrators-guide/configuration-parameters">Administrator's Guide</a>.
* <ol>
* <li>dataDir - The directory where the ZooKeeper data is stored.</li>
* <li>dataLogDir - The directory where the ZooKeeper transaction log is stored.</li>
Expand Down
6 changes: 6 additions & 0 deletions zookeeper-website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,9 @@ node_modules/
/blob-report/
/playwright/.cache/
/playwright/.auth/

# Generated developer list (see scripts/extract-developers.js)
/app/pages/_landing/credits/developers.json

# Generated sitemap (see scripts/generate-sitemap.ts)
/public/sitemap.xml
78 changes: 0 additions & 78 deletions zookeeper-website/app/components/docs/archive-docs-banner.tsx

This file was deleted.

2 changes: 1 addition & 1 deletion zookeeper-website/app/components/getting-started.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export function GettingStartedSection() {
{
title: "3. Write a Client",
desc: "Follow the basic tutorial to implement distributed primitives like barriers and queues.",
to: `${CURRENT_DOCS_PATH}/developer/basic-tutorial`
to: "https://cwiki.apache.org/confluence/display/ZOOKEEPER/Tutorial"
}
];
return (
Expand Down
Loading
Loading