ISSUE #441: fix typos
Descriptions of the changes in this PR:
Fix typos in docker readme.
"Apache ZooKeeper is a software project of the Apache Software Foundation"
->
"Apache Bookkeeper is a software project of the Apache Software Foundation"
"bookkepeer servers" -> "bookkeeper servers"
"The client only need to connect to a Zookkeeper server in the ensamble"
->
"The client only need to connect to a Zookeeper server in the ensemble"
typo of other place:
bookeeper
->
bookkeeper
wile
->
while
acknoledge
->
acknowledge
Author: zhaijack <zhaijia03@gmail.com>
Reviewers: Enrico Olivelli <eolivelli@gmail.com>, Sijie Guo <sijie@apache.org>
This closes #442 from zhaijack/issue_441, closes #441
(cherry picked from commit e988a3cb876b5939e103e36b985ddab05173569c)
Signed-off-by: Sijie Guo <sijie@apache.org>
diff --git a/CHANGES.txt b/CHANGES.txt
index 3f6fd3e..e308701 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1144,9 +1144,9 @@
BOOKKEEPER-19: BookKeeper doesn't support more than 2Gig of memory (ivan via fpj)
- BOOKEEPER-22: Exception in LedgerCache causes addEntry request to fail (fpj via fpj)
+ BOOKKEEPER-22: Exception in LedgerCache causes addEntry request to fail (fpj via fpj)
- BOOKEEPER-5: Issue with Netty in BookKeeper (fpj and ivank via fpj)
+ BOOKKEEPER-5: Issue with Netty in BookKeeper (fpj and ivank via fpj)
BOOKKEEPER-30: Test are too noisy (ivank via fpj)
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java
index 2cd5903..7c81d6d 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java
@@ -581,7 +581,7 @@
* read entries for which the writer has not received the acknowledge yet. <br>
* For entries which are within the range 0..LastAddConfirmed BookKeeper guarantees that the writer has successfully
* received the acknowledge.<br>
- * For entries outside that range it is possible that the writer never received the acknoledge
+ * For entries outside that range it is possible that the writer never received the acknowledge
* and so there is the risk that the reader is seeing entries before the writer and this could result in a consistency
* issue in some cases.<br>
* With this method you can even read entries before the LastAddConfirmed and entries after it with one call,
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandleAdv.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandleAdv.java
index 527d084..672edd8 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandleAdv.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandleAdv.java
@@ -40,7 +40,7 @@
/**
* Ledger Advanced handle extends {@link LedgerHandle} to provide API to add entries with
- * user supplied entryIds. Through this interface Ledger Length may not be accurate wile the
+ * user supplied entryIds. Through this interface Ledger Length may not be accurate while the
* ledger being written.
*/
public class LedgerHandleAdv extends LedgerHandle {
diff --git a/bookkeeper-server/src/main/java/org/apache/bookkeeper/util/Main.java b/bookkeeper-server/src/main/java/org/apache/bookkeeper/util/Main.java
index b289bc4..3e9583c 100644
--- a/bookkeeper-server/src/main/java/org/apache/bookkeeper/util/Main.java
+++ b/bookkeeper-server/src/main/java/org/apache/bookkeeper/util/Main.java
@@ -29,7 +29,7 @@
public class Main {
static void usage() {
- System.err.println("USAGE: bookeeper client|bookie");
+ System.err.println("USAGE: bookkeeper client|bookie");
}
/**
diff --git a/doc/bookkeeperSecurity.textile b/doc/bookkeeperSecurity.textile
index 6969e6c..ff50c9c 100644
--- a/doc/bookkeeperSecurity.textile
+++ b/doc/bookkeeperSecurity.textile
@@ -20,7 +20,7 @@
Then you have to take care of access to Bookies, you can configure authentication and encryption using TLS, out of the box BookKeeper supports Kerberos authentication, DIGEST-MD5 authentication and TLS encryption. You can also leverage TLS client authentication in order to protect your data.
-h1. ZookKeeper security on BookKeeper
+h1. ZooKeeper security on BookKeeper
Both clients and Bookies read and write metadata on ZooKeeper, it is also used for Bookie discovery.
The best way to protect data stored on ZooKeeper is to put ACLs on every z-node, this way only authorized users will be able to access (read/write) data
diff --git a/docker/Makefile b/docker/Makefile
index 64078db..23a3ecf 100644
--- a/docker/Makefile
+++ b/docker/Makefile
@@ -36,7 +36,7 @@
BK_zkLedgersRootPath = /ledgers
ZK_CONTAINER_NAME=test_zookeeper
-ZK_LOCAL_DATA_DIR=$(BK_LOCAL_DATA_DIR)/zookkeeper
+ZK_LOCAL_DATA_DIR=$(BK_LOCAL_DATA_DIR)/zookeeper
TERMINAL_EMULATOR=gnome-terminal
@@ -62,7 +62,7 @@
# -------------------------------- #
-# Create and run a bookkeeper container with data persisted on local filesystem. It needs the zookkeeper container.
+# Create and run a bookkeeper container with data persisted on local filesystem. It needs the zookeeper container.
# In order to launch several bookies, the command need the bookie number
# make run-bk BOOKIE=4
@@ -88,7 +88,7 @@
# -------------------------------- #
-# Create run and destroy a container that will format zookkeeper metadata
+# Create run and destroy a container that will format zookeeper metadata
# make run-format
run-format:
@@ -100,7 +100,7 @@
# -------------------------------- #
-# Create and run the zookkeeper container needed by the ensemble
+# Create and run the zookeeper container needed by the ensemble
# make run-zk
run-zk:
@@ -129,7 +129,7 @@
# -------------------------------- #
-# This is an example of a full bookkeeper ensemble of 3 bookies, a zookkeeper server and 2 client dice applications.
+# This is an example of a full bookkeeper ensemble of 3 bookies, a zookeeper server and 2 client dice applications.
# On MacOS please run these command manually in several terminals
# make run-demo
run-demo:
diff --git a/docker/README.md b/docker/README.md
index 7b7cb36..d3def65 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,14 +1,14 @@
# What is Apache Bookkeeper?
-Apache ZooKeeper is a software project of the Apache Software Foundation, providing a replicated log service which can be used to build replicated state machines. A log contains a sequence of events which can be applied to a state machine. BookKeeper guarantees that each replica state machine will see all the same entries, in the same order.
+Apache Bookkeeper is a software project of the Apache Software Foundation, providing a replicated log service which can be used to build replicated state machines. A log contains a sequence of events which can be applied to a state machine. BookKeeper guarantees that each replica state machine will see all the same entries, in the same order.
> [Apache Bookkeeper](http://bookkeeper.apache.org/)
# How to use this image
-Bookkeeper needs [Zookeeper](https://zookeeper.apache.org/) in order to preserve its state and publish its bookies (bookkepeer servers). The client only need to connect to a Zookkeeper server in the ensamble in order to obtain the list of Bookkeeper servers.
+Bookkeeper needs [Zookeeper](https://zookeeper.apache.org/) in order to preserve its state and publish its bookies (Bookkeeper servers). The client only need to connect to a Zookeeper server in the ensamble in order to obtain the list of Bookkeeper servers.
## TL;DR
@@ -64,21 +64,21 @@
In order to play with our freshly created ensemble, you can use the simple application taken from [Bookkeeper Tutorial](http://bookkeeper.apache.org/docs/master/bookkeeperTutorial.html) and packaged in a [docker image](https://github.com/caiok/bookkeeper-tutorial) for convenience.
-This application check if it can be leader, if yes start to roll a dice and book this rolls on bookkeeper, otherwise it will start to follow the leader rolls. If leader stops, follower will try to become leader and so on.
+This application check if it can be leader, if yes start to roll a dice and book this rolls on Bookkeeper, otherwise it will start to follow the leader rolls. If leader stops, follower will try to become leader and so on.
Start a dice application (you can run it several times to view the behavior in a concurrent environment):
```
docker run -it --rm \
--network "my-bookkeeper-network" \
- --env ZK_URL=my-zookkeeper:2181 \
+ --env ZK_URL=my-zookeeper:2181 \
caiok/bookkeeper-tutorial
```
## Configuration
-Bookkeeper configuration is located in `/opt/bookkeeper/conf` in the docker container, it is a copy of [these files](https://github.com/apache/bookkeeper/tree/master/bookkeeper-server/conf) in bookkeeper repo.
+Bookkeeper configuration is located in `/opt/bookkeeper/conf` in the docker container, it is a copy of [these files](https://github.com/apache/bookkeeper/tree/master/bookkeeper-server/conf) in Bookkeeper repo.
-There are 2 ways to set bookkeeper configuration:
+There are 2 ways to set Bookkeeper configuration:
1, Apply setted (e.g. docker -e kk=vv) environment variables into configuration files. Environment variable names is in format "BK_originalName", in which "originalName" is the key in config files.
@@ -94,7 +94,7 @@
bookkeeper
```
-### Override rules for bookkeeper configuration
+### Override rules for Bookkeeper configuration
If you have applied several ways to set the same config target, e.g. the environment variable names contained in [these files](https://github.com/apache/bookkeeper/tree/master/bookkeeper-server/conf) and conf_file in /opt/bookkeeper/conf/.
Then the override rules is as this:
@@ -132,7 +132,7 @@
#### `BK_zkLedgersRootPath`
-This variable allows you to specify the root directory bookkeeper will use on Zookeeper to store ledgers metadata.
+This variable allows you to specify the root directory Bookkeeper will use on Zookeeper to store ledgers metadata.
This will override `zkLedgersRootPath ` in [bk_server.conf](https://github.com/apache/bookkeeper/blob/master/bookkeeper-server/conf/bk_server.conf).
@@ -140,7 +140,7 @@
#### `BK_CLUSTER_ROOT_PATH`
-This variable allows you to specify the root directory bookkeeper will use on Zookeeper.
+This variable allows you to specify the root directory Bookkeeper will use on Zookeeper.
Default value is empty - " ". so ledgers dir in zookeeper will be at "/ledgers" by default. You could set it as that you want, e.g. "/bookkeeper"
@@ -153,7 +153,7 @@
### Configure files under /opt/bookkeeper/conf
-These files is originally un-tared from the bookkeeper building binary, such as [bookkeeper-server-4.4.0-bin.tar.tgz](https://archive.apache.org/dist/bookkeeper/bookkeeper-4.4.0/bookkeeper-4.4.0-src.tar.gz), and it comes from [these files](https://github.com/apache/bookkeeper/tree/master/bookkeeper-server/conf) in bookkeeper repo.
+These files is originally un-tared from the bookkeeper building binary, such as [bookkeeper-server-4.4.0-bin.tar.tgz](https://archive.apache.org/dist/bookkeeper/bookkeeper-4.4.0/bookkeeper-4.4.0-src.tar.gz), and it comes from [these files](https://github.com/apache/bookkeeper/tree/master/bookkeeper-server/conf) in Bookkeeper repo.
Usually we could config files bk_server.conf, bkenv.sh, log4j.properties, and log4j.shell.properties. Please read and understand them before you do the configuration.
diff --git a/site/README.md b/site/README.md
index cd6d4a9..469ad27 100644
--- a/site/README.md
+++ b/site/README.md
@@ -50,7 +50,7 @@
Here are a few steps to follow to stage your changes:
1. You need to create a github repo called `bookkeeper-staging-site` under your github account. You can fork this [staging repo](https://github.com/sijie/bookkeeper-staging-site) as well.
-2. In your `bookeeper-staging-site` repo, go to `Settings > GitHub Pages`. Enable `GitHub Pages` on `master branch /docs folder`.
+2. In your `bookkeeper-staging-site` repo, go to `Settings > GitHub Pages`. Enable `GitHub Pages` on `master branch /docs folder`.
3. Make changes to the website, follow the steps above to verify the changes locally.
4. Once the changes are verified locally, you can run `make staging`. It will generate the files under `site/local-generated`.
5. Run `scripts/staging-website.sh`. It would push the generated website to your `bookkeeper-staging-site`.
diff --git a/site/docs/getting-started/run-locally.md b/site/docs/getting-started/run-locally.md
index 691b918..edbfab9 100644
--- a/site/docs/getting-started/run-locally.md
+++ b/site/docs/getting-started/run-locally.md
@@ -1,7 +1,7 @@
---
title: Run bookies locally
-prev: /docs/getting-started/installation
-next: /docs/getting-started/concepts
+prev: ../installation
+next: ../concepts
toc_disable: true
---
@@ -10,7 +10,7 @@
This would start up an ensemble with 10 bookies:
```shell
-$ bookeeper-server/bin/bookeeper localbookie 10
+$ bookkeeper-server/bin/bookkeeper localbookie 10
```
> When you start up an ensemble using `localbookie`, all bookies run in a single JVM process.
