This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new c7667de2ee6b [improve][doc] SEO for Reference (#703)
c7667de2ee6b is described below
commit c7667de2ee6bf70c0d120787b70497b7e8483932
Author: Zhang Yuxuan <[email protected]>
AuthorDate: Mon Sep 25 20:53:47 2023 +0800
[improve][doc] SEO for Reference (#703)
---
docs/pulsar-api-overview.md | 3 ++-
docs/reference-cli-tools.md | 1 +
docs/reference-rest-api-overview.md | 1 +
docs/reference-terminology.md | 44 +++++++++++++++----------------------
4 files changed, 22 insertions(+), 27 deletions(-)
diff --git a/docs/pulsar-api-overview.md b/docs/pulsar-api-overview.md
index 839055fc48e6..07d3ab0b03a4 100644
--- a/docs/pulsar-api-overview.md
+++ b/docs/pulsar-api-overview.md
@@ -2,6 +2,7 @@
id: pulsar-api-overview
title: Pulsar APIs
sidebar_label: "Pulsar APIs"
+description: Get a comprehensive understanding of concepts, functionalities,
and distinctions of Pulsar APIs.
---
````mdx-code-block
@@ -16,7 +17,7 @@ As the core building blocks of Pulsar, Pulsar APIs allow you
to:
- build applications with Pulsar using client APIs
- administer Pulsar clusters using admin APIs
-
+
## Pulsar client APIs
diff --git a/docs/reference-cli-tools.md b/docs/reference-cli-tools.md
index 4d148c7c0ace..ddb5477726ee 100644
--- a/docs/reference-cli-tools.md
+++ b/docs/reference-cli-tools.md
@@ -2,6 +2,7 @@
id: reference-cli-tools
title: Pulsar command-line tools
sidebar_label: "Pulsar CLI tools"
+description: Learn how to use Pulsar command-line tools.
---
Pulsar offers several command-line tools that you can use for managing Pulsar
installations, performance testing, using command-line producers and consumers,
and more.
diff --git a/docs/reference-rest-api-overview.md
b/docs/reference-rest-api-overview.md
index ee6d7d8c1347..f6551281360f 100644
--- a/docs/reference-rest-api-overview.md
+++ b/docs/reference-rest-api-overview.md
@@ -2,6 +2,7 @@
id: reference-rest-api-overview
title: Pulsar REST APIs
sidebar_label: "REST APIs"
+description: Get a comprehensive understanding of Pulsar REST APIs.
---
A REST API (also known as RESTful API, REpresentational State Transfer
Application Programming Interface) is a set of definitions and protocols for
building and integrating application software, using HTTP requests to GET, PUT,
POST, and DELETE data following the REST standards. In essence, REST API is a
set of remote calls using standard methods to request and return data in a
specific format between two systems.
diff --git a/docs/reference-terminology.md b/docs/reference-terminology.md
index 070ffa23ebdc..ee6754773753 100644
--- a/docs/reference-terminology.md
+++ b/docs/reference-terminology.md
@@ -2,6 +2,7 @@
id: reference-terminology
title: Pulsar Terminology
sidebar_label: "Terminology"
+description: Get a comprehensive understanding of Pulsar terminologies.
---
Here is a glossary of terms related to Apache Pulsar:
@@ -14,18 +15,18 @@ Pulsar is a distributed messaging system originally created
by Yahoo but now und
### Namespace Bundle
-A virtual group of [topics](#topic) that belong to the same
[namespace](#namespace). A namespace bundle
+Namespace bundle is a virtual group of [topics](concepts-messaging.md#topics)
that belong to the same [namespace](concepts-multi-tenancy.md#namespaces). A
namespace bundle
is defined as a range between two 32-bit hashes, such as 0x00000000 and
0xffffffff.
### Pub-Sub
-A messaging pattern in which [producer](#producer) processes publish messages
on [topics](#topic) that
-are then consumed (processed) by [consumer](#consumer) processes.
+Pub-sub is a messaging pattern in which
[producer](concepts-clients.md#producer) processes publish messages on
[topics](concepts-messaging.md#topics) that
+are then consumed (processed) by [consumer](concepts-clients.md#consumer)
processes.
### Reader
-Pulsar readers are message processors much like Pulsar [consumers](#consumer)
but with two crucial differences:
+Pulsar readers are message processors much like Pulsar
[consumers](concepts-clients.md#consumer) but with two crucial differences:
- you can specify *where* on a topic readers begin processing messages
(consumers always begin with the latest
available unacked message);
@@ -33,56 +34,47 @@ Pulsar readers are message processors much like Pulsar
[consumers](#consumer) bu
### Cursor
-The subscription position for a [consumer](#consumer).
+Cursor is the subscription position for a
[consumer](concepts-clients.md#consumer).
### Unacknowledged
-A message that has been delivered to a consumer for processing but not yet
confirmed as processed by the consumer.
+Unacknowledged means a message that has been delivered to a consumer for
processing but not yet confirmed as processed by the consumer.
### Retention Policy
-Size and time limits that you can set on a [namespace](#namespace) to
configure retention of [messages](#message)
-that have already been [acknowledged](#acknowledgment-ack).
+Retention policy is the size and time limits that you can set on a
[namespace](concepts-multi-tenancy.md#namespaces) to configure retention of
[messages](concepts-messaging.md#messages)
+that have already been [acknowledged](concepts-messaging.md#acknowledgment).
### Multi-Tenancy
-The ability to isolate [namespaces](#namespace), specify quotas, and configure
authentication and authorization
-on a per-[tenant](#tenant) basis.
+Multi-tenancy is the ability to isolate
[namespaces](concepts-multi-tenancy.md#namespaces), specify quotas, and
configure authentication and authorization
+on a per-[tenant](concepts-multi-tenancy.md#tenants) basis.
### Failure Domain
-A logical domain under a Pulsar cluster. Each logical domain contains a
pre-configured list of brokers.
+Failure domain is a logical domain under a Pulsar cluster. Each logical domain
contains a pre-configured list of brokers.
-### Anti-affinity Namespaces
+### Anti-Affinity Namespaces
-A group of namespaces that have anti-affinity to each other.
+Anti-affinity namespaces are a group of namespaces that have anti-affinity to
each other.
## Architecture
### Standalone
-A lightweight Pulsar broker in which all components run in a single Java
Virtual Machine (JVM) process. Standalone
+Standalone is a lightweight Pulsar broker in which all components run in a
single Java Virtual Machine (JVM) process. Standalone
clusters can be run on a single machine and are useful for development
purposes.
-### Instance
-
-A group of Pulsar [clusters](#cluster) that act together as a single unit.
-
-### Geo-Replication
-
-Replication of messages across Pulsar [clusters](#cluster), potentially in
different datacenters
-or geographical regions.
-
### Topic Lookup
-A service provided by Pulsar [brokers](#broker) that enables connecting
clients to automatically determine
-which Pulsar [cluster](#cluster) is responsible for a [topic](#topic) (and
thus where message traffic for
+Topic lookup is a service provided by Pulsar
[brokers](concepts-architecture-overview.md#brokers) that enables connecting
clients to automatically determine
+which Pulsar [cluster](concepts-architecture-overview.md#clusters) is
responsible for a [topic](concepts-messaging.md#topics) (and thus where message
traffic for
the topic needs to be routed).
### Dispatcher
-An asynchronous TCP server used for all data transfers in and out of a Pulsar
[broker](#broker). The Pulsar
+Dispatcher is an asynchronous TCP server used for all data transfers in and
out of a Pulsar [broker](concepts-architecture-overview.md#brokers). The Pulsar
dispatcher uses a custom binary protocol for all communications.
## Storage
