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 73a9ddfa6f5 [improve][doc] SEO for Admin API (#702)
73a9ddfa6f5 is described below
commit 73a9ddfa6f52aa0957e6ccbe38adc061b798c3be
Author: Zhang Yuxuan <[email protected]>
AuthorDate: Tue Sep 19 14:51:41 2023 +0800
[improve][doc] SEO for Admin API (#702)
---
docs/admin-api-brokers.md | 1 +
docs/admin-api-clusters.md | 1 +
docs/admin-api-features.md | 3 ++-
docs/admin-api-functions.md | 1 +
docs/admin-api-namespaces.md | 1 +
docs/admin-api-overview.md | 3 ++-
docs/admin-api-packages.md | 1 +
docs/admin-api-permissions.md | 1 +
docs/admin-api-schemas.md | 1 +
docs/admin-api-tenants.md | 1 +
docs/admin-api-tools.md | 3 ++-
docs/admin-api-topics.md | 1 +
docs/admin-api-transactions.md | 1 +
docs/admin-api-tutorial.md | 1 +
docs/admin-api-use-cases.md | 3 ++-
docs/admin-get-started.md | 49 +++++++++++++++++++++---------------------
docs/reference-terminology.md | 19 ----------------
17 files changed, 44 insertions(+), 47 deletions(-)
diff --git a/docs/admin-api-brokers.md b/docs/admin-api-brokers.md
index ed75539bb4b..65114086fa7 100644
--- a/docs/admin-api-brokers.md
+++ b/docs/admin-api-brokers.md
@@ -2,6 +2,7 @@
id: admin-api-brokers
title: Managing Brokers
sidebar_label: "Brokers"
+description: Learn how to manage brokers using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-clusters.md b/docs/admin-api-clusters.md
index 38e2cabc4a6..e632d96790c 100644
--- a/docs/admin-api-clusters.md
+++ b/docs/admin-api-clusters.md
@@ -2,6 +2,7 @@
id: admin-api-clusters
title: Managing Clusters
sidebar_label: "Clusters"
+description: Learn how to manage clusters using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-features.md b/docs/admin-api-features.md
index bda78e950bb..0ba81cac47b 100644
--- a/docs/admin-api-features.md
+++ b/docs/admin-api-features.md
@@ -2,6 +2,7 @@
id: admin-api-features
title: Pulsar admin interfaces - Features
sidebar_label: "Features"
+description: Get a comprehensive understanding of features of Pulsar admin
APIs.
---
````mdx-code-block
@@ -11,7 +12,7 @@ import TabItem from '@theme/TabItem';
Below are the most common tasks you may want to do. For the exhaustive lists
of tasks and the method to perform these tasks, see [Tools](admin-api-tools.md).
-
+
These administrative tasks are categorized based on Pulsar components.
diff --git a/docs/admin-api-functions.md b/docs/admin-api-functions.md
index 72750f69d81..95189c0f499 100644
--- a/docs/admin-api-functions.md
+++ b/docs/admin-api-functions.md
@@ -2,6 +2,7 @@
id: admin-api-functions
title: Manage Functions
sidebar_label: "Functions"
+description: Learn how to manage functions using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-namespaces.md b/docs/admin-api-namespaces.md
index a7a6b297c65..6624f9d95c8 100644
--- a/docs/admin-api-namespaces.md
+++ b/docs/admin-api-namespaces.md
@@ -2,6 +2,7 @@
id: admin-api-namespaces
title: Managing Namespaces
sidebar_label: "Namespaces"
+description: Learn how to manage namespaces using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-overview.md b/docs/admin-api-overview.md
index ff257316d9e..4131f1d4db4 100644
--- a/docs/admin-api-overview.md
+++ b/docs/admin-api-overview.md
@@ -2,6 +2,7 @@
id: admin-api-overview
title: Pulsar admin interfaces
sidebar_label: "Overview"
+description: Get a comprehensive understanding of usage of Pulsar admin APIs.
---
````mdx-code-block
@@ -11,7 +12,7 @@ import TabItem from '@theme/TabItem';
Pulsar admin APIs enable you to administer clusters programmatically. For
example, you can create, update, delete, and manage all the entities within
Pulsar instances (such as clusters, namespaces, tenants, topics, schemas,
connectors, functions, and so on), and set various policies for data,
resources, and security.
-
+
### Related topics
diff --git a/docs/admin-api-packages.md b/docs/admin-api-packages.md
index 84645db6814..01bbfffe57c 100644
--- a/docs/admin-api-packages.md
+++ b/docs/admin-api-packages.md
@@ -2,6 +2,7 @@
id: admin-api-packages
title: Manage packages
sidebar_label: "Packages"
+description: Learn how to manage packages using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-permissions.md b/docs/admin-api-permissions.md
index 78936e0f0ba..5d1eb2e2629 100644
--- a/docs/admin-api-permissions.md
+++ b/docs/admin-api-permissions.md
@@ -2,6 +2,7 @@
id: admin-api-permissions
title: Managing permissions
sidebar_label: "Permissions"
+description: Learn how to manage permissions using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-schemas.md b/docs/admin-api-schemas.md
index 7bb9a166d18..03a02e483cb 100644
--- a/docs/admin-api-schemas.md
+++ b/docs/admin-api-schemas.md
@@ -2,6 +2,7 @@
id: admin-api-schemas
title: Manage Schemas
sidebar_label: "Schemas"
+description: Learn how to manage schemas using Pulsar CLI and admin APIs.
---
diff --git a/docs/admin-api-tenants.md b/docs/admin-api-tenants.md
index 7d99824ed54..7d61305fb92 100644
--- a/docs/admin-api-tenants.md
+++ b/docs/admin-api-tenants.md
@@ -2,6 +2,7 @@
id: admin-api-tenants
title: Managing Tenants
sidebar_label: "Tenants"
+description: Learn how to manage tenants using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-tools.md b/docs/admin-api-tools.md
index ecc5f716e6e..d3cec7a8308 100644
--- a/docs/admin-api-tools.md
+++ b/docs/admin-api-tools.md
@@ -2,6 +2,7 @@
id: admin-api-tools
title: Pulsar admin interfaces - Tools
sidebar_label: "Tools"
+description: Get a comprehensive understanding of concepts and difference of
Pulsar admin CLI and Pulsar admin APIs.
---
````mdx-code-block
@@ -21,7 +22,7 @@ You can manage Pulsar entities through the Pulsar admin layer
via one of the fol
- [pulsar-admin
CLI](pathname:///reference/#/@pulsar:version_reference@/pulsar-admin/): It’s a
command-line tool and is available in the bin folder of your Pulsar
installation.
-
+
Here are the explanations and comparisons of these tools.
diff --git a/docs/admin-api-topics.md b/docs/admin-api-topics.md
index b4640562720..2b9e1c6fdba 100644
--- a/docs/admin-api-topics.md
+++ b/docs/admin-api-topics.md
@@ -2,6 +2,7 @@
id: admin-api-topics
title: Manage topics
sidebar_label: "Topics"
+description: Learn how to manage topics using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-transactions.md b/docs/admin-api-transactions.md
index b07cbbfd8f8..ec5e6e5bd97 100644
--- a/docs/admin-api-transactions.md
+++ b/docs/admin-api-transactions.md
@@ -2,6 +2,7 @@
id: admin-api-transactions
title: Manage transactions
sidebar_label: "Transactions"
+description: Learn how to manage transactions using Pulsar CLI and admin APIs.
---
````mdx-code-block
diff --git a/docs/admin-api-tutorial.md b/docs/admin-api-tutorial.md
index 6423b699eff..17665cbc2d8 100644
--- a/docs/admin-api-tutorial.md
+++ b/docs/admin-api-tutorial.md
@@ -2,6 +2,7 @@
id: admin-api-tutorial
title: Tutorial
sidebar_label: "Tutorial"
+description: Learn how to configure Pulsar admin interfaces if authentication
is enabled in your Pulsar instance.
---
````mdx-code-block
diff --git a/docs/admin-api-use-cases.md b/docs/admin-api-use-cases.md
index 68d2b7175d9..87d5704a488 100644
--- a/docs/admin-api-use-cases.md
+++ b/docs/admin-api-use-cases.md
@@ -2,6 +2,7 @@
id: admin-api-use-cases
title: Pulsar admin interfaces - Use cases
sidebar_label: "Use cases"
+description: Get a comprehensive understanding of use cases of Pulsar admin
APIs.
---
````mdx-code-block
@@ -17,7 +18,7 @@ Pulsar admin APIs are one of the best productivity tools. You
can perform variou
- Facilitating the workflow of application development by implementing admin
interface clients using your preferred languages (e.g., Go, Python, C++) based
on REST APIs, which enhances developer experiences.
-
+
### Related topics
diff --git a/docs/admin-get-started.md b/docs/admin-get-started.md
index dc8b3cde0cc..3114c629235 100644
--- a/docs/admin-get-started.md
+++ b/docs/admin-get-started.md
@@ -2,6 +2,7 @@
id: admin-api-get-started
title: Get started
sidebar_label: "Get started"
+description: Learn how to manage topics in Pulsar using the Pulsar admin CLI
or Pulsar admin APIs.
---
````mdx-code-block
@@ -17,17 +18,17 @@ This guide walks you through the quickest way to get
started with the following
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
<TabItem value="pulsar-admin">
-[pulsar-admin
CLI](pathname:///reference/#/@pulsar:version_reference@/pulsar-admin/): it’s a
command-line tool and is available in the bin folder of your Pulsar
installation.
+[pulsar-admin
CLI](pathname:///reference/#/@pulsar:version_reference@/pulsar-admin/) is a
command-line tool and is available in the bin folder of your Pulsar
installation.
</TabItem>
<TabItem value="REST API">
-[REST API](pathname:///admin-rest-api/?version=@pulsar:version_number@): HTTP
calls, which are made against the admin APIs provided by brokers. In addition,
both the Java admin API and pulsar-admin CLI use the REST API.
+[REST API](pathname:///admin-rest-api/?version=@pulsar:version_number@)
belongs to HTTP calls, which are made against the admin APIs provided by
brokers. In addition, both the Java admin API and pulsar-admin CLI use the REST
API.
</TabItem>
<TabItem value="Java">
-[Java admin API](/api/admin/): it’s a programmable interface written in Java.
+[Java admin API](/api/admin/) is a programmable interface written in Java.
</TabItem>
@@ -42,7 +43,7 @@ Check the detailed steps below.
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
<TabItem value="pulsar-admin">
-This tutorial guides you through every step of using pulsar-admin CLI to
manage topics. It includes the following steps:
+To manage topics using pulsar-admin CLI, complte the following steps.
1. Set the service URL.
@@ -54,7 +55,7 @@ This tutorial guides you through every step of using
pulsar-admin CLI to manage
5. Check the stats of the topic.
-6. Delete the topic.
+6. Delete the topic.
**Prerequisites**
@@ -62,14 +63,14 @@ This tutorial guides you through every step of using
pulsar-admin CLI to manage
**Steps**
-1. Set the service URLs to point to the broker service in
[client.conf](https://github.com/apache/pulsar/blob/master/conf/client.conf).
+**Step 1:** Set the service URLs to point to the broker service in
[client.conf](https://github.com/apache/pulsar/blob/master/conf/client.conf).
```bash
webServiceUrl=http://localhost:8080/
brokerServiceUrl=pulsar://localhost:6650/
```
-2. Create a persistent topic named _test-topic-1_ with 6 partitions.
+**Step 2:** Create a persistent topic named _test-topic-1_ with 6 partitions.
**Input**
@@ -83,7 +84,7 @@ This tutorial guides you through every step of using
pulsar-admin CLI to manage
There is no output. You can check the status of the topic in Step 5.
-3. Update the number of the partition to 8.
+**Step 3:** Update the number of the partition to 8.
**Input**
@@ -97,7 +98,7 @@ This tutorial guides you through every step of using
pulsar-admin CLI to manage
There is no output. You can check the number of partitions in Step 5.
-4. Produce some messages to the partitioned topic _test-topic-1_.
+**Step 4:** Produce some messages to the partitioned topic _test-topic-1_.
**Input**
@@ -139,7 +140,7 @@ This tutorial guides you through every step of using
pulsar-admin CLI to manage
2023-03-07T15:35:03,769+0800 [Thread-0] INFO
org.apache.pulsar.testclient.PerformanceProducer - Aggregated latency stats ---
Latency: mean: 8.931 ms - med: 3.775 - 95pct: 32.144 - 99pct: 98.432 -
99.9pct: 216.088 - 99.99pct: 304.807 - 99.999pct: 349.391 - Max: 351.235
```
-5. Check the internal stats of the partitioned topic _test-topic-1_.
+**Step 5:** Check the internal stats of the partitioned topic _test-topic-1_.
**Input**
@@ -230,7 +231,7 @@ This tutorial guides you through every step of using
pulsar-admin CLI to manage
...
```
-6. Delete the topic _test-topic-1_.
+**Step 6:** Delete the topic _test-topic-1_.
**Input**
@@ -253,7 +254,7 @@ This tutorial guides you through every step of using
pulsar-admin CLI to manage
</TabItem>
<TabItem value="REST API">
-This tutorial guides you through every step of using REST API to manage
topics. It includes the following steps:
+To manage topics using REST API, complete the following steps.
1. Create a partitioned topic
@@ -271,7 +272,7 @@ This tutorial guides you through every step of using REST
API to manage topics.
**Steps**
-1. Create a persistent topic named _test-topic-2_ with 4 partitions.
+**Step 1:** Create a persistent topic named _test-topic-2_ with 4 partitions.
**Input**
@@ -283,7 +284,7 @@ This tutorial guides you through every step of using REST
API to manage topics.
There is no output. You can check the topic in Step 4.
-2. Update the number of the partition to 5.
+**Step 2:** Update the number of the partition to 5.
**Input**
@@ -295,7 +296,7 @@ This tutorial guides you through every step of using REST
API to manage topics.
There is no output. You can check the status of the topic in Step 4.
-3. Produce some messages to the partitioned topic _test-topic-2_.
+**Step 3:** Produce some messages to the partitioned topic _test-topic-2_.
**Input**
@@ -365,7 +366,7 @@ This tutorial guides you through every step of using REST
API to manage topics.
2023-03-08T15:53:28,178+0800 [Thread-0] INFO
org.apache.pulsar.testclient.PerformanceProducer - Aggregated latency stats ---
Latency: mean: 4.481 ms - med: 2.918 - 95pct: 10.710 - 99pct: 38.928 -
99.9pct: 112.689 - 99.99pct: 154.241 - 99.999pct: 193.249 - Max: 241.717
```
-4. Check the internal stats of the topic _test-topic-2_.
+**Step 4:** Check the internal stats of the topic _test-topic-2_.
**Input**
@@ -381,7 +382,7 @@ This tutorial guides you through every step of using REST
API to manage topics.
{"metadata":{"partitions":5},"partitions":{"persistent://public/default/test-topic-2-partition-3":{"entriesAddedCounter":47087,"numberOfEntries":47087,"totalSize":80406959,"currentLedgerEntries":47087,"currentLedgerSize":80406959,"lastLedgerCreatedTimestamp":"2023-03-08T15:47:07.273+08:00","waitingCursorsCount":0,"pendingAddEntriesCount":0,"lastConfirmedEntry":"117:47086","state":"LedgerOpened","ledgers":[{"ledgerId":117,"entries":0,"size":0,"offloaded":false,"underReplicated":false}
[...]
```
-5. Delete the topic _test-topic-2_.
+**Step 5:** Delete the topic _test-topic-2_.
**Input**
@@ -404,7 +405,7 @@ This tutorial guides you through every step of using REST
API to manage topics.
</TabItem>
<TabItem value="Java">
-This tutorial guides you through every step of using Java admin API to manage
topics. It includes the following steps:
+To manage topics using Java admin API, complete following steps.
1. Initiate a Pulsar Java client.
@@ -432,7 +433,7 @@ This tutorial guides you through every step of using Java
admin API to manage to
**Steps**
-1. Initiate a Pulsar Java client in your Java project.
+**Step 1:** Initiate a Pulsar Java client in your Java project.
**Input**
@@ -443,7 +444,7 @@ This tutorial guides you through every step of using Java
admin API to manage to
.build();
```
-2. Create a partitioned topic _test-topic-1_ with 4 partitions.
+**Step 2:** Create a partitioned topic _test-topic-1_ with 4 partitions.
**Input**
@@ -451,7 +452,7 @@ This tutorial guides you through every step of using Java
admin API to manage to
admin.topics().createPartitionedTopic("persistent://public/default/test-topic-1",
4);
```
-3. Update the number of the partition to 5.
+**Step 3:** Update the number of the partition to 5.
**Input**
@@ -459,7 +460,7 @@ This tutorial guides you through every step of using Java
admin API to manage to
admin.topics().updatePartitionedTopic("test-topic-1", 5);
```
-4. Produce some messages to the topic _test-topic-1_.
+**Step 4:** Produce some messages to the topic _test-topic-1_.
**Input**
@@ -480,7 +481,7 @@ This tutorial guides you through every step of using Java
admin API to manage to
client.close();
```
-5. Check the stats of the topic _test-topic-1_.
+**Step 5:** Check the stats of the topic _test-topic-1_.
**Input**
@@ -495,7 +496,7 @@ This tutorial guides you through every step of using Java
admin API to manage to
100
```
-6. Delete the topic _test-topic-1_.
+**Step 6:** Delete the topic _test-topic-1_.
**Input**
diff --git a/docs/reference-terminology.md b/docs/reference-terminology.md
index 276ea288622..070ffa23ebd 100644
--- a/docs/reference-terminology.md
+++ b/docs/reference-terminology.md
@@ -12,30 +12,11 @@ Here is a glossary of terms related to Apache Pulsar:
Pulsar is a distributed messaging system originally created by Yahoo but now
under the stewardship of the Apache Software Foundation.
-### Message
-
-Messages are the basic unit of Pulsar. They're what [producers](#producer)
publish to [topics](#topic)
-and what [consumers](#consumer) then consume from topics.
-
-### Topic
-
-A named channel used to pass messages published by [producers](#producer) to
[consumers](#consumer) who
-process those [messages](#message).
-
-### Partitioned Topic
-
-A topic that is served by multiple Pulsar [brokers](#broker), which enables
higher throughput.
-
### Namespace Bundle
A virtual group of [topics](#topic) that belong to the same
[namespace](#namespace). A namespace bundle
is defined as a range between two 32-bit hashes, such as 0x00000000 and
0xffffffff.
-### Subscription
-
-A lease on a [topic](#topic) established by a group of [consumers](#consumer).
Pulsar has four subscription
-modes (exclusive, shared, failover and key_shared).
-
### Pub-Sub
A messaging pattern in which [producer](#producer) processes publish messages
on [topics](#topic) that
