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 41b760e12a5 [improve][doc] add instructions of env variables to CLI
docs (#422)
41b760e12a5 is described below
commit 41b760e12a523d1d40cba878bbce89d89572c817
Author: Anonymitaet <[email protected]>
AuthorDate: Tue Feb 21 16:57:45 2023 +0800
[improve][doc] add instructions of env variables to CLI docs (#422)
---
static/reference/next/cli.md | 10 ++++++++--
static/reference/next/config/README.md | 2 --
static/reference/next/pulsar-admin/README.md | 17 ++++++++++++++++-
static/reference/next/pulsar-client/README.md | 13 ++++++++++++-
static/reference/next/pulsar-perf/README.md | 13 ++++++++++++-
5 files changed, 48 insertions(+), 7 deletions(-)
diff --git a/static/reference/next/cli.md b/static/reference/next/cli.md
index 520d14e5b03..e79763044aa 100644
--- a/static/reference/next/cli.md
+++ b/static/reference/next/cli.md
@@ -1,3 +1,9 @@
-# Welcome
+Pulsar offers several command-line tools that help you manage Pulsar and
BookKeeper, produce and consume messages, administer Pulsar entities, test
Pulsar, and more.
-> Welcome to Pulsar CLI Tools Docs.
+|Goal|Tool
+|---|---
+Manage Pulsar| - `pulsar` <br/><br/> -
[`pulsar-daemon`](/next/pulsar-daemon/pulsar-daemon) <br/><br/> -
[`pulsar-shell`](/next/pulsar-shell/pulsar-shell)
+Produce and consume messages |
[`pulsar-client`](/next/pulsar-client/pulsar-client)
+Administer Pulsar entities | `pulsar-admin`
+Test Pulsar | [`pulsar-perf`](/next/pulsar-perf/pulsar-perf)
+Manage BookKeeper | [`bookkeper`](/next/bookkeeper/bookkeeper)
\ No newline at end of file
diff --git a/static/reference/next/config/README.md
b/static/reference/next/config/README.md
index 4c21b3ffef5..ad972bcd507 100644
--- a/static/reference/next/config/README.md
+++ b/static/reference/next/config/README.md
@@ -1,7 +1,5 @@
## Pulsar configurations
-Pulsar offers several command-line tools that you can use for managing Pulsar
installations, performance testing, using command-line producers and consumers,
and more.
-
You can manage Pulsar configurations through configuration files in the
[`conf`](https://github.com/apache/pulsar/tree/master/conf) directory of a
Pulsar installation.
- [BookKeeper](/next/config/reference-configuration-bookkeeper)
diff --git a/static/reference/next/pulsar-admin/README.md
b/static/reference/next/pulsar-admin/README.md
index 614dee15501..3180c0ef14d 100644
--- a/static/reference/next/pulsar-admin/README.md
+++ b/static/reference/next/pulsar-admin/README.md
@@ -1 +1,16 @@
-> Docs for `pulsar-admin`.
+`pulsar-admin` is a tool used to administer Pulsar entities.
+
+## Environment variables
+
+You can use the following environment variables to configure `pulsar-admin`.
+
+|Variable|Description|Default|
+|---|---|---|
+|`PULSAR_LOG_CONF`|Log4j configuration file|conf/log4j2.yaml|
+|`PULSAR_CLIENT_CONF`|Configuration file for the client|conf/client.conf|
+|`PULSAR_EXTRA_OPTS`|Extra options passed to the JVM|N/A|
+|`PULSAR_EXTRA_CLASSPATH`|Extra paths for Pulsar's classpath|N/A|
+
+## Related topics
+
+- [Pulsar admin API](docs/admin-api-overview)
\ No newline at end of file
diff --git a/static/reference/next/pulsar-client/README.md
b/static/reference/next/pulsar-client/README.md
index f9c6768b025..f875e02f284 100644
--- a/static/reference/next/pulsar-client/README.md
+++ b/static/reference/next/pulsar-client/README.md
@@ -1 +1,12 @@
-> Docs for `pulsar-client`.
+`pulsar-client` is a tool used to produce and consume messages.
+
+## Environment variables
+
+You can use the following environment variables to configure `pulsar-client`.
+
+|Variable|Description|Default|
+|---|---|---|
+|`PULSAR_LOG_CONF`|Log4j configuration file|conf/log4j2.yaml|
+|`PULSAR_CLIENT_CONF`|Configuration file for the client|conf/client.conf|
+|`PULSAR_EXTRA_OPTS`|Extra options passed to the JVM|N/A|
+|`PULSAR_EXTRA_CLASSPATH`|Extra paths for Pulsar's classpath|N/A|
\ No newline at end of file
diff --git a/static/reference/next/pulsar-perf/README.md
b/static/reference/next/pulsar-perf/README.md
index 61098e50893..6359464dd35 100644
--- a/static/reference/next/pulsar-perf/README.md
+++ b/static/reference/next/pulsar-perf/README.md
@@ -1 +1,12 @@
-> Docs for `pulsar-perf`.
+`pulsar-perf` is a tool used to test the performance of Pulsar brokers.
+
+## Environment variables
+
+You can use the following environment variables to configure `pulsar-perf`.
+
+|Variable|Description|Default|
+|---|---|---|
+|`PULSAR_LOG_CONF`|Log4j configuration file|conf/log4j2.yaml|
+|`PULSAR_CLIENT_CONF`|Configuration file for the client|conf/client.conf|
+|`PULSAR_EXTRA_OPTS`|Extra options passed to the JVM|N/A|
+|`PULSAR_EXTRA_CLASSPATH`|Extra paths for Pulsar's classpath|N/A|
\ No newline at end of file
