From d43b1d40102dcaf165990259a7b315b1b14f0f30 Mon Sep 17 00:00:00 2001 From: Anonymitaet Date: Wed, 19 Oct 2022 12:46:28 +0800 Subject: [PATCH 1/2] [fix][doc] Optimize URLS for CLI tools page --- site2/docs/reference-cli-tools.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/site2/docs/reference-cli-tools.md b/site2/docs/reference-cli-tools.md index cde841484a4f4..adb1f65f40da7 100644 --- a/site2/docs/reference-cli-tools.md +++ b/site2/docs/reference-cli-tools.md @@ -6,14 +6,13 @@ sidebar_label: "Pulsar CLI 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. -* [`pulsar-admin`](https://pulsar.apache.org/reference/#/latest/pulsar-admin/) -* [`pulsar`](https://pulsar.apache.org/reference/#/latest/pulsar/) -* [`pulsar-client`](https://pulsar.apache.org/reference/#/latest/pulsar-client/) -* [`pulsar-perf`](https://pulsar.apache.org/reference/#/latest/pulsar-perf/) -* [`pulsar-daemon`](reference-cli-pulsar-daemon.md) +* [`pulsar-admin`](https://pulsar.apache.org/reference) +* [`pulsar`](https://pulsar.apache.org/reference) +* [`pulsar-client`](https://pulsar.apache.org/reference) +* [`pulsar-daemon`](https://pulsar.apache.org/reference) +* [`pulsar-perf`](https://pulsar.apache.org/reference) * [`pulsar-shell`](reference-cli-pulsar-shell.md) -* [`bookkeeper`](reference-cli-bookkeeper.md) -* [`broker-tool`](reference-cli-broker-tool.md) +* [`bookkeeper`](https://pulsar.apache.org/reference) All Pulsar command-line tools can be run from the `bin` directory of your [installed Pulsar package](getting-started-standalone.md). From a800c3429dbf756c1abf98317730f17fe91af12e Mon Sep 17 00:00:00 2001 From: Anonymitaet Date: Tue, 25 Oct 2022 10:28:40 +0800 Subject: [PATCH 2/2] update --- site2/docs/about.md | 2 +- site2/docs/reference-cli-tools.md | 24 ++++++++++++++---------- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/site2/docs/about.md b/site2/docs/about.md index f198373497800..6a1dd53837275 100644 --- a/site2/docs/about.md +++ b/site2/docs/about.md @@ -55,7 +55,7 @@ You’ll notice an Edit button at the bottom and top of each page. Click it to o :::tip -For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](https://docs.google.com/document/d/11DTnNPpvcPrebLkMAFcDEIFlD8ARD-k6F-LXoIwdD9Y/edit#). +For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](https://github.com/apache/pulsar/blob/master/site2/README.md). ::: diff --git a/site2/docs/reference-cli-tools.md b/site2/docs/reference-cli-tools.md index adb1f65f40da7..7d28866076e8b 100644 --- a/site2/docs/reference-cli-tools.md +++ b/site2/docs/reference-cli-tools.md @@ -6,13 +6,19 @@ sidebar_label: "Pulsar CLI 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. -* [`pulsar-admin`](https://pulsar.apache.org/reference) -* [`pulsar`](https://pulsar.apache.org/reference) -* [`pulsar-client`](https://pulsar.apache.org/reference) -* [`pulsar-daemon`](https://pulsar.apache.org/reference) -* [`pulsar-perf`](https://pulsar.apache.org/reference) -* [`pulsar-shell`](reference-cli-pulsar-shell.md) -* [`bookkeeper`](https://pulsar.apache.org/reference) +* `pulsar-admin` +* `pulsar` +* `pulsar-client` +* `pulsar-daemon` +* `pulsar-perf` +* `pulsar-shell` +* `bookkeeper` + +::: tip + +For the latest and complete information about command-line tools, including commands, flags, descriptions, and more information, see [Pulsar Reference](https://pulsar.apache.org/reference). + +::: All Pulsar command-line tools can be run from the `bin` directory of your [installed Pulsar package](getting-started-standalone.md). @@ -20,6 +26,4 @@ You can get help for any CLI tool, command, or subcommand using the `--help` fla ```shell bin/pulsar broker --help -``` - - +``` \ No newline at end of file