This is an automated email from the ASF dual-hosted git repository.
junma 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 15f0c43f507 [improve][doc] tweak structure for admin API and CLI (#471)
15f0c43f507 is described below
commit 15f0c43f507a09514a964395e01416afbcf9b7b6
Author: Anonymitaet <[email protected]>
AuthorDate: Thu Mar 16 10:01:02 2023 +0800
[improve][doc] tweak structure for admin API and CLI (#471)
---
...-get-started.md => get-started-pulsar-admin.md} | 6 +--
docs/how-to-landing.md | 3 +-
sidebars.json | 48 +++++++++++-----------
3 files changed, 29 insertions(+), 28 deletions(-)
diff --git a/docs/reference-cli-get-started.md
b/docs/get-started-pulsar-admin.md
similarity index 98%
rename from docs/reference-cli-get-started.md
rename to docs/get-started-pulsar-admin.md
index c2ac0d37f4c..07de1debb94 100644
--- a/docs/reference-cli-get-started.md
+++ b/docs/get-started-pulsar-admin.md
@@ -1,7 +1,7 @@
---
-id: reference-cli-get-started
-title: Get Started
-sidebar_label: "Get started"
+id: get-started-pulsar-admin
+title: Get started with pulsar-admin CLI tool
+sidebar_label: "Get started with pulsar-admin"
---
This tutorial guides you through every step of using pulsar-admin CLI to
manage topics. It includes the following steps:
diff --git a/docs/how-to-landing.md b/docs/how-to-landing.md
index 39690c6deee..c28013c6a93 100644
--- a/docs/how-to-landing.md
+++ b/docs/how-to-landing.md
@@ -10,4 +10,5 @@ Learning new software can be an overwhelming task, but relax
– most aspects of
- [How to create a tenant](tutorials-tenant.md)
- [How to create a namespace](tutorials-namespace.md)
- [How to create a topic](tutorials-topic.md)
-- [How to produce and consume messages](tutorials-produce-consume.md)
\ No newline at end of file
+- [How to produce and consume messages](tutorials-produce-consume.md)
+- [Get started with pulsar-admin CLI tool](get-started-pulsar-admin.md)
\ No newline at end of file
diff --git a/sidebars.json b/sidebars.json
index 6cfcd1f6ca2..afd3568c3bb 100644
--- a/sidebars.json
+++ b/sidebars.json
@@ -440,20 +440,29 @@
"items": [
"admin-api-overview",
"admin-api-use-cases",
- "admin-api-features",
+ {
+ "type": "category",
+ "label": "Features",
+ "link": {
+ "type": "doc",
+ "id": "admin-api-features"
+ },
+ "items": [
+ "admin-api-clusters",
+ "admin-api-tenants",
+ "admin-api-brokers",
+ "admin-api-namespaces",
+ "admin-api-permissions",
+ "admin-api-topics",
+ "admin-api-functions",
+ "admin-api-packages",
+ "admin-api-schemas",
+ "admin-api-transactions"
+ ]
+ },
"admin-api-tools",
"admin-api-get-started",
- "admin-api-tutorial",
- "admin-api-clusters",
- "admin-api-tenants",
- "admin-api-brokers",
- "admin-api-namespaces",
- "admin-api-permissions",
- "admin-api-topics",
- "admin-api-functions",
- "admin-api-packages",
- "admin-api-schemas",
- "admin-api-transactions"
+ "admin-api-tutorial"
]
},
{
@@ -482,7 +491,8 @@
"cookbooks-non-persistent",
"cookbooks-retention-expiry",
"cookbooks-message-queue",
- "cookbooks-bookkeepermetadata"
+ "cookbooks-bookkeepermetadata",
+ "get-started-pulsar-admin"
]
},
{
@@ -508,17 +518,7 @@
},
"items": [
"reference-terminology",
- {
- "type": "category",
- "label": "CLI tools",
- "link": {
- "type": "doc",
- "id": "reference-cli-tools"
- },
- "items": [
- "reference-cli-get-started"
- ]
- },
+ "reference-cli-tools",
"reference-configuration",
"reference-metrics",
"reference-rest-api-overview",
