This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 04d5e22 [Doc] Add explanations for partition key (#11239)
04d5e22 is described below
commit 04d5e22a2b471ad355b0fd05e81b0dcaf03fb094
Author: Anonymitaet <[email protected]>
AuthorDate: Fri Jul 9 10:46:17 2021 +0800
[Doc] Add explanations for partition key (#11239)
* [Doc] Add explanations for partition key
* update
Co-authored-by: Anonymitaet <anonymitaet_hotmail.com>
---
site2/docs/admin-api-brokers.md | 4 ++--
site2/docs/admin-api-clusters.md | 4 ++--
site2/docs/admin-api-functions.md | 4 ++--
site2/docs/admin-api-namespaces.md | 4 ++--
site2/docs/admin-api-overview.md | 8 ++++----
site2/docs/admin-api-packages.md | 4 ++--
site2/docs/admin-api-permissions.md | 4 ++--
site2/docs/admin-api-tenants.md | 4 ++--
site2/docs/admin-api-topics.md | 4 ++--
site2/docs/developing-binary-protocol.md | 2 +-
site2/docs/reference-pulsar-admin.md | 2 +-
11 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/site2/docs/admin-api-brokers.md b/site2/docs/admin-api-brokers.md
index 5a2939e..a41616b 100644
--- a/site2/docs/admin-api-brokers.md
+++ b/site2/docs/admin-api-brokers.md
@@ -8,9 +8,9 @@ sidebar_label: Brokers
>
> This page only shows **some frequently used operations**.
>
-> - For the latest and complete information about `pulsar-admin`, including
commands, flags, descriptions, and more, see [pulsar-admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> - For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/)
>
-> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including
> classes, methods, descriptions, and more, see [Java admin API
> doc](https://pulsar.apache.org/api/admin/).
diff --git a/site2/docs/admin-api-clusters.md b/site2/docs/admin-api-clusters.md
index 45aacb3..5f88af7 100644
--- a/site2/docs/admin-api-clusters.md
+++ b/site2/docs/admin-api-clusters.md
@@ -8,9 +8,9 @@ sidebar_label: Clusters
>
> This page only shows **some frequently used operations**.
>
-> - For the latest and complete information about `pulsar-admin`, including
commands, flags, descriptions, and more, see [pulsar-admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> - For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/)
>
-> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including
> classes, methods, descriptions, and more, see [Java admin API
> doc](https://pulsar.apache.org/api/admin/).
diff --git a/site2/docs/admin-api-functions.md
b/site2/docs/admin-api-functions.md
index b530051..50b89ba 100644
--- a/site2/docs/admin-api-functions.md
+++ b/site2/docs/admin-api-functions.md
@@ -8,9 +8,9 @@ sidebar_label: Functions
>
> This page only shows **some frequently used operations**.
>
-> - For the latest and complete information about `pulsar-admin`, including
commands, flags, descriptions, and more, see [pulsar-admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> - For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/)
>
-> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including
> classes, methods, descriptions, and more, see [Java admin API
> doc](https://pulsar.apache.org/api/admin/).
diff --git a/site2/docs/admin-api-namespaces.md
b/site2/docs/admin-api-namespaces.md
index d1631a7..3e0e9a5 100644
--- a/site2/docs/admin-api-namespaces.md
+++ b/site2/docs/admin-api-namespaces.md
@@ -8,9 +8,9 @@ sidebar_label: Namespaces
>
> This page only shows **some frequently used operations**.
>
-> - For the latest and complete information about `pulsar-admin`, including
commands, flags, descriptions, and more, see [pulsar-admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> - For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/)
>
-> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including
> classes, methods, descriptions, and more, see [Java admin API
> doc](https://pulsar.apache.org/api/admin/).
diff --git a/site2/docs/admin-api-overview.md b/site2/docs/admin-api-overview.md
index 0ea3105..e610e05 100644
--- a/site2/docs/admin-api-overview.md
+++ b/site2/docs/admin-api-overview.md
@@ -16,19 +16,19 @@ You can interact with the admin interface via:
> **Important**
>
- > For the latest and complete information about Java admin API, including
commands, flags, descriptions, and more, see
[here](https://pulsar.apache.org/tools/pulsar-admin/).
+ > For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
- HTTP calls, which are made against the admin {@inject: rest:REST:/} API
provided by Pulsar brokers. For some RESTful APIs, they might be redirected to
the owner brokers for serving with [`307 Temporary
Redirect`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307), hence
the HTTP callers should handle `307 Temporary Redirect`. If you use `curl`
commands, you should specify `-L` to handle redirections.
> **Important**
- >
- > For the latest and complete information about REST API, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+ >
+ > For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
- A Java client interface.
> **Important**
>
- > For the latest and complete information about Java admin API, including
classes, methods, descriptions, and more, see [Java admin API
doc](https://pulsar.apache.org/api/admin/).
+ > For the latest and complete information about `Java admin API`, including
classes, methods, descriptions, and more, see [Java admin API
doc](https://pulsar.apache.org/api/admin/).
> **The REST API is the admin interface**. Both the `pulsar-admin` CLI tool
> and the Java client use the REST API. If you implement your own admin
> interface client, you should use the REST API.
diff --git a/site2/docs/admin-api-packages.md b/site2/docs/admin-api-packages.md
index 6137dd8..03e4d51 100644
--- a/site2/docs/admin-api-packages.md
+++ b/site2/docs/admin-api-packages.md
@@ -8,9 +8,9 @@ sidebar_label: Packages
>
> This page only shows **some frequently used operations**.
>
-> - For the latest and complete information about `pulsar-admin`, including
commands, flags, descriptions, and more, see [pulsar-admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> - For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/)
>
-> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including
> classes, methods, descriptions, and more, see [Java admin API
> doc](https://pulsar.apache.org/api/admin/).
diff --git a/site2/docs/admin-api-permissions.md
b/site2/docs/admin-api-permissions.md
index cedc471..78adb37 100644
--- a/site2/docs/admin-api-permissions.md
+++ b/site2/docs/admin-api-permissions.md
@@ -8,9 +8,9 @@ sidebar_label: Permissions
>
> This page only shows **some frequently used operations**.
>
-> - For the latest and complete information about `pulsar-admin`, including
commands, flags, descriptions, and more, see [pulsar-admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> - For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/)
>
-> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including
> classes, methods, descriptions, and more, see [Java admin API
> doc](https://pulsar.apache.org/api/admin/).
diff --git a/site2/docs/admin-api-tenants.md b/site2/docs/admin-api-tenants.md
index 7a6ef0c..a2d82e4 100644
--- a/site2/docs/admin-api-tenants.md
+++ b/site2/docs/admin-api-tenants.md
@@ -8,9 +8,9 @@ sidebar_label: Tenants
>
> This page only shows **some frequently used operations**.
>
-> - For the latest and complete information about `pulsar-admin`, including
commands, flags, descriptions, and more, see [pulsar-admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> - For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/)
>
-> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including
> classes, methods, descriptions, and more, see [Java admin API
> doc](https://pulsar.apache.org/api/admin/).
diff --git a/site2/docs/admin-api-topics.md b/site2/docs/admin-api-topics.md
index 624c888..8904cd1 100644
--- a/site2/docs/admin-api-topics.md
+++ b/site2/docs/admin-api-topics.md
@@ -8,9 +8,9 @@ sidebar_label: Topics
>
> This page only shows **some frequently used operations**.
>
-> - For the latest and complete information about `pulsar-admin`, including
commands, flags, descriptions, and more, see [pulsar-admin
doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> - For the latest and complete information about `Pulsar admin`, including
commands, flags, descriptions, and more, see [Pulsar admin
doc](https://pulsar.apache.org/tools/pulsar-admin/)
>
-> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see [REST API doc]{@inject:
rest:REST:/}.
+> - For the latest and complete information about `REST API`, including
parameters, responses, samples, and more, see {@inject: rest:REST:/} API doc.
>
> - For the latest and complete information about `Java admin API`, including
> classes, methods, descriptions, and more, see [Java admin API
> doc](https://pulsar.apache.org/api/admin/).
diff --git a/site2/docs/developing-binary-protocol.md
b/site2/docs/developing-binary-protocol.md
index 46585c2..434ffa7 100644
--- a/site2/docs/developing-binary-protocol.md
+++ b/site2/docs/developing-binary-protocol.md
@@ -61,7 +61,7 @@ Message metadata is stored alongside the
application-specified payload as a seri
| `publish_time` | The publish timestamp in Unix time
(i.e. as the number of milliseconds since January 1st, 1970 in UTC)
|
| `properties` | A sequence of key/value pairs (using
the
[`KeyValue`](https://github.com/apache/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto#L32)
message). These are application-defined keys and values with no special
meaning to Pulsar. |
| `replicated_from` *(optional)* | Indicates that the message has been
replicated and specifies the name of the
[cluster](reference-terminology.md#cluster) where the message was originally
published
|
-| `partition_key` *(optional)* | While publishing on a partition
topic, if the key is present, the hash of the key is used to determine which
partition to choose
|
+| `partition_key` *(optional)* | While publishing on a partition
topic, if the key is present, the hash of the key is used to determine which
partition to choose. Partition key is used as the message key.
|
| `compression` *(optional)* | Signals that payload has been
compressed and with which compression library
|
| `uncompressed_size` *(optional)* | If compression is used, the producer
must fill the uncompressed size field with the original payload size
|
| `num_messages_in_batch` *(optional)* | If this message is really a
[batch](#batch-messages) of multiple entries, this field must be set to the
number of messages in the batch
|
diff --git a/site2/docs/reference-pulsar-admin.md
b/site2/docs/reference-pulsar-admin.md
index 51a6fc2..8506189 100644
--- a/site2/docs/reference-pulsar-admin.md
+++ b/site2/docs/reference-pulsar-admin.md
@@ -6,7 +6,7 @@ sidebar_label: Pulsar Admin CLI
> **Important**
>
-> This page is deprecated and not updated anymore. For the latest and complete
information about `pulsar-admin`, including commands, flags, descriptions, and
more, see [pulsar-admin doc](https://pulsar.apache.org/tools/pulsar-admin/).
+> This page is deprecated and not updated anymore. For the latest and complete
information about `Pulsar admin`, including commands, flags, descriptions, and
more, see [Pulsar admin doc](https://pulsar.apache.org/tools/pulsar-admin/)
The `pulsar-admin` tool enables you to manage Pulsar installations, including
clusters, brokers, namespaces, tenants, and more.
