Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

amend some typographic errors in documents #286

Merged
merged 1 commit into from
Mar 10, 2017
Merged
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
22 changes: 7 additions & 15 deletions docs/AdminTools.md
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,7 @@ admin.clusters().deleteCluster(cluster)

#### list all clusters

It gives a list of call created clusters in Pulsar system.
It gives a list of all created clusters in Pulsar system.

###### CLI

Expand Down Expand Up @@ -2386,10 +2386,6 @@ In your terminal, go to below directory to play with client tool.
<td>```-m, --messages```</td>
<td>```Comma separted string messages to send. Cannot be used with -f. Either -m or -f must be provided```</td>
</tr>
<tr>
<td>```-np, --non-persistent```</td>
<td>```Produce non-persistent message, Default: false```</td>
</tr>
<tr>
<td>```-n, --num-produce```</td>
<td>```Number of times to send message(s), Default: 1```</td>
Expand All @@ -2398,10 +2394,6 @@ In your terminal, go to below directory to play with client tool.
<td>```-r, --rate```</td>
<td>```Rate (in msg/sec) at which to produce. Value of 0 will produce messages as fast as possible, Default: 0.0```</td>
</tr>
<tr>
<td>```--ttl```</td>
<td>```Time to live (in ms) for the messages. Value of 0 will result in unlimited TTL, Default: 3600000```</td>
</tr>
<table>

#### consume message command
Expand All @@ -2414,10 +2406,6 @@ In your terminal, go to below directory to play with client tool.
<th>options</th>
<th>description</th>
</tr>
<tr>
<td>```-c, --client-id```</td>
<td>```Client ID for subscriber connection. Required if subscriber ID also specified```</td>
</tr>
<tr>
<td>```--hex```</td>
<td>```Display binary messages in hex, Default: false```</td>
Expand All @@ -2431,7 +2419,11 @@ In your terminal, go to below directory to play with client tool.
<td>```Rate (in msg/sec) at which to consume. Value of 0 will consume messages as fast as possible, Default: 0.0```</td>
</tr>
<tr>
<td>```-s, --subscriber-id```</td>
<td>```Subscriber ID for a durable subscriber```</td>
<td>```-s, --subscription-name```</td>
<td>```Subscription name```</td>
</tr>
<tr>
<td>```-t, --subscription-type```</td>
<td>```Subscription type: Exclusive, Shared, Failover, Default: Exclusive```</td>
</tr>
<table>
2 changes: 1 addition & 1 deletion docs/BinaryProtocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Commands for different producers and consumers can be interleaved and sent
through the same connection without any restriction.

All the commands are embedded in a
[`BaseCommand`](https://github.com/yahoo/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto#L283)
[`BaseCommand`](https://github.com/yahoo/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto#L335)
protobuf object that includes a type enum and all the possible sub-commands as
optional fields. At any time, one `BaseCommand` can only have set a single
sub-command.
Expand Down
4 changes: 2 additions & 2 deletions docs/ClusterSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
ledgerManagerType=hierarchical
```

Please consult [http://bookkeeper.apache.org/]() for more extensive documentation
Please consult http://bookkeeper.apache.org/ for more extensive documentation
on Apache BookKeeper.

##### Starting the service
Expand Down Expand Up @@ -317,7 +317,7 @@ for messages:
$ bin/pulsar-perf consume persistent://test/us-west/ns1/my-topic
```

Start a produce that publishes messages at a fixed rate and report stats every
Start a producer that publishes messages at a fixed rate and report stats every
10 seconds:

```shell
Expand Down
2 changes: 1 addition & 1 deletion docs/GeoReplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- [Replication model](#replication-model)
- [Configuring replication](#configuring-replication)
- [Granting permissions to properties](#granting-permissions-to-properties)
- [Creating the namespace](#creating-the-namespace)
- [Creating global namespaces](#creating-global-namespaces)
- [Using global topics](#using-global-topics)

<!-- /TOC -->
Expand Down
2 changes: 1 addition & 1 deletion docs/WebSocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ http://{serviceUrl}:8080/ws/producer/persistent/{property}/{cluster}/{namespace}

### Consumer

Open a WebSocket session to create a producer for a specific topic:
Open a WebSocket session to create a consumer for a specific topic:

```perl
http://{serviceUrl}:8080/ws/consumer/persistent/{property}/{cluster}/{namespace}/{topic}/{subscription}
Expand Down