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 704ccf5ab66 cleanup cli docs generation: BUILD_ALL_VERSION=1 (#273)
704ccf5ab66 is described below
commit 704ccf5ab66111ff815f979b58741c4d71b1d183
Author: tison <[email protected]>
AuthorDate: Wed Nov 2 07:59:55 2022 +0800
cleanup cli docs generation: BUILD_ALL_VERSION=1 (#273)
---
site2/tools/publish-website.sh | 2 -
site2/tools/pulsar-config-doc-gen.sh | 7 -
.../website-next/docs/reference-cli-bookkeeper.md | 106 --------------
.../website-next/docs/reference-cli-broker-tool.md | 36 -----
.../docs/reference-cli-pulsar-daemon.md | 48 -------
.../docs/reference-cli-pulsar-shell.md | 155 ---------------------
6 files changed, 354 deletions(-)
diff --git a/site2/tools/publish-website.sh b/site2/tools/publish-website.sh
index 765cc8db84c..aa0b5f1aa79 100755
--- a/site2/tools/publish-website.sh
+++ b/site2/tools/publish-website.sh
@@ -61,8 +61,6 @@ PULSAR_SITE_TMP=/tmp/pulsar-site
| grep -v $PULSAR_SITE_TMP/content/charts \
| grep -v $PULSAR_SITE_TMP/content/css \
| grep -v $PULSAR_SITE_TMP/content/tools \
- | grep -v $PULSAR_SITE_TMP/content/reference \
- | grep -v $PULSAR_SITE_TMP/content/.htaccess \
| xargs rm -rf
fi
rsync -a $GENERATED_SITE_DIR/content/ $PULSAR_SITE_TMP/content
diff --git a/site2/tools/pulsar-config-doc-gen.sh
b/site2/tools/pulsar-config-doc-gen.sh
index 0977aae7555..f11b20ab0db 100755
--- a/site2/tools/pulsar-config-doc-gen.sh
+++ b/site2/tools/pulsar-config-doc-gen.sh
@@ -52,10 +52,3 @@ $JAVA -cp "$CLIENT_CP:$(cat "$f")" $GEN_DOCS_CLIENT -c
$CLIENT_CONF.ClientConfig
$JAVA -cp "$CLIENT_CP:$(cat "$f")" $GEN_DOCS_CLIENT -c
$CLIENT_CONF.ProducerConfigurationData >
"$CLIENT_DIR"/client-configuration-producer.md
$JAVA -cp "$CLIENT_CP:$(cat "$f")" $GEN_DOCS_CLIENT -c
$CLIENT_CONF.ConsumerConfigurationData >
"$CLIENT_DIR"/client-configuration-consumer.md
$JAVA -cp "$CLIENT_CP:$(cat "$f")" $GEN_DOCS_CLIENT -c
$CLIENT_CONF.ReaderConfigurationData >
"$CLIENT_DIR"/client-configuration-reader.md
-
-# copy CLI tools docs
-tools="bookkeeper pulsar-daemon pulsar-shell"
-for tool in $tools
-do
- cp "$WEBSITE/docs/reference-cli-$tool.md" "$VERSIONED_DIR/$tool/$tool.md"
-done
diff --git a/site2/website-next/docs/reference-cli-bookkeeper.md
b/site2/website-next/docs/reference-cli-bookkeeper.md
deleted file mode 100644
index 2f6cf6ac7e8..00000000000
--- a/site2/website-next/docs/reference-cli-bookkeeper.md
+++ /dev/null
@@ -1,106 +0,0 @@
----
-id: reference-cli-bookkeeper
-title: Pulsar CLI tools - bookkeeper
-sidebar_label: "cli-bookkeeper"
----
-
-## `bookkeeper`
-A tool for managing BookKeeper.
-
-Usage
-
-```bash
-bookkeeper command
-```
-
-Environment variables
-
-The table below lists the environment variables that you can use to configure
the bookkeeper tool.
-
-|Variable|Description|Default|
-|---|---|---|
-|BOOKIE_LOG_CONF|Log4j configuration file|conf/log4j2.yaml|
-|BOOKIE_CONF|BookKeeper configuration file|conf/bk_server.conf|
-|BOOKIE_EXTRA_OPTS|Extra options to be passed to the JVM||
-|BOOKIE_EXTRA_CLASSPATH|Extra paths for BookKeeper's classpath||
-|ENTRY_FORMATTER_CLASS|The Java class used to format entries||
-|BOOKIE_PID_DIR|Folder where the BookKeeper server PID file should be stored||
-|BOOKIE_STOP_TIMEOUT|Wait time before forcefully killing the Bookie server
instance if attempts to stop it are not successful||
-|BOOKIE_GC_LOG|Gc options to be passed to the jvm||
-
-
-### `autorecovery`
-Runs an auto-recovery service
-
-Usage
-
-```bash
-bookkeeper autorecovery options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery||
-
-
-### `bookie`
-Starts up a BookKeeper server (aka bookie)
-
-Usage
-
-```bash
-bookkeeper bookie options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery||
-|-readOnly|Force start a read-only bookie server|false|
-|-withAutoRecovery|Start auto-recovery service bookie server|false|
-
-
-### `localbookie`
-Runs a test ensemble of N bookies locally
-
-Usage
-
-```bash
-bookkeeper localbookie N
-```
-
-### `upgrade`
-Upgrade the bookie’s filesystem
-
-Usage
-
-```bash
-bookkeeper upgrade options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery||
-|`-u`, `--upgrade`|Upgrade the bookie’s directories||
-
-
-### `shell`
-Run shell for admin commands. To see a full listing of those commands, run
bookkeeper shell without an argument.
-
-Usage
-
-```bash
-bookkeeper shell
-```
-
-Example
-
-```bash
-bookkeeper shell bookiesanity
-```
-
diff --git a/site2/website-next/docs/reference-cli-broker-tool.md
b/site2/website-next/docs/reference-cli-broker-tool.md
deleted file mode 100644
index 56e2de9f5a2..00000000000
--- a/site2/website-next/docs/reference-cli-broker-tool.md
+++ /dev/null
@@ -1,36 +0,0 @@
----
-id: reference-cli-broker-tool
-title: Pulsar CLI tools - broker-tool
-sidebar_label: "cli-broker-tool"
----
-
-## `broker-tool`
-
-The `broker- tool` is used for operations on a specific broker.
-
-Usage
-
-```bash
-broker-tool command
-```
-
-Example
-
-Two ways to get more information about a command as below:
-
-```bash
-broker-tool help command
-broker-tool command --help
-```
-
-### `load-report`
-
-Collect the load report of a specific broker.
-The command is run on a broker, and used for troubleshooting why broker can’t
collect right load report.
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-i`, `--interval`| Interval to collect load report, in milliseconds ||
-|`-h`, `--help`| Display help information ||
diff --git a/site2/website-next/docs/reference-cli-pulsar-daemon.md
b/site2/website-next/docs/reference-cli-pulsar-daemon.md
deleted file mode 100644
index b210f1793da..00000000000
--- a/site2/website-next/docs/reference-cli-pulsar-daemon.md
+++ /dev/null
@@ -1,48 +0,0 @@
----
-id: reference-cli-pulsar-daemon
-title: Pulsar CLI tools - pulsar-daemon
-sidebar_label: "cli-pulsar-daemon"
----
-
-## `pulsar-daemon`
-
-A wrapper around the pulsar tool that’s used to start and stop processes, such
as ZooKeeper, bookies, and Pulsar brokers, in the background using nohup.
-
-pulsar-daemon has a similar interface to the pulsar command but adds start and
stop commands for various services. For a listing of those services, run
pulsar-daemon to see the help output or see the documentation for the pulsar
command.
-
-Usage
-
-```bash
-pulsar-daemon command
-```
-
-### `start`
-Start a service in the background using nohup.
-
-Usage
-
-```bash
-pulsar-daemon start service
-```
-
-### `stop`
-Stop a service that’s already been started using start.
-
-Usage
-
-```bash
-pulsar-daemon stop service options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|-force|Stop the service forcefully if not stopped by normal shutdown.|false|
-
-### `restart`
-Restart a service that has already been started.
-
-```bash
-pulsar-daemon restart service
-```
\ No newline at end of file
diff --git a/site2/website-next/docs/reference-cli-pulsar-shell.md
b/site2/website-next/docs/reference-cli-pulsar-shell.md
deleted file mode 100644
index fc22af59034..00000000000
--- a/site2/website-next/docs/reference-cli-pulsar-shell.md
+++ /dev/null
@@ -1,155 +0,0 @@
----
-id: reference-cli-pulsar-shell
-title: Pulsar CLI tools - pulsar-shell
-sidebar_label: "cli-pulsar-shell"
----
-
-## `pulsar-shell`
-
-[Pulsar shell](administration-pulsar-shell.md) tool.
-
-### Interactive mode
-
-Usage
-
-```bash
-pulsar-shell
-```
-
-Options
-
-| Flag | Description
| Default |
-|--------------------|---------------------------------------------------------------------------|------------------|
-| `-c`, `--config` | Client configuration file. It is used as a `default`
config. | conf/client.conf |
-| `--fail-on-error` | If true, the shell is interrupted when a command throws
an exception. | false |
-| `-h`, `--help` | Show this help.
| |
-
-
-### Non interactive mode
-
-Usage
-
-```bash
-pulsar-shell -f [FILE]
-pulsar-shell -e [COMMAND]
-echo "[COMMAND]" | pulsar-shell -
-```
-
-Options
-
-| Flag | Description
| Default |
-|---------------------------|-----------------------------------------------------------------------------------------------------|-----------------|
-| `-c`, `--config` | Client configuration file. It is used as a
`default` config. | conf/client.conf |
-| `--fail-on-error` | If true, the shell is interrupted when a command
throws an exception. | false |
-| `-np`, `--no-progress` | Display raw output of the commands without the
fancy progress visualization. | false |
-| `-f`, `--filename` | Input filename with a list of commands to be
executed. Each command must be separated by a newline. | |
-| `-e`, `--execute-command` | Execute this command and exit.
| |
-| `-` | Read commands from the standard input.
| |
-| `-h`, `--help` | Show this help.
| |
-
-
-Commands
-* `admin` - See [Admin API](admin-api-overview.md)
-* `client` - See [pulsar-client](#pulsar-client)
-* `config`
-
-
-### `config`
-
-Manage shell configurations.
-
-#### `use`
-
-Use a specific configuration for next commands.
-
-```bash
-default(localhost)> config use mycluster
-```
-
-#### `create`
-
-Create a new configuration.
-
-```bash
-default(localhost)> config create --file ./conf/client.conf mycluster
-```
-
-Options
-
-| Flag | Description | Default |
-|----------|--------------------------|-----------------|
-| `--file` | File path of the config. | |
-| `--url` | URL of the config. | |
-| `--value` | Inline value of the config. Base64-encoded value is supported
with the prefix `base64:`. | |
-
-#### `update`
-
-Update an existing configuration.
-
-```bash
-default(localhost)> config update --file ./conf/client.conf mycluster
-```
-
-Options
-
-| Flag | Description | Default |
-|----------|--------------------------|-----------------|
-| `--file` | File path of the config. | |
-| `--url` | URL of the config. | |
-| `--value` | Inline value of the config. Base64-encoded value is supported
with the prefix `base64:`. | |
-
-#### `set-property`
-
-Set a value for a specified configuration property.
-
-```bash
-default(localhost)> config set-property -p webServiceUrl -v
http://<cluster-hostname> mycluster
-```
-
-Options
-
-| Flag | Description | Default |
-|--------------------|-----------------------------|-----------------|
-| `-p`, `--property` | Property name to update. | |
-| `-v`, `--value` | New value for the property. | |
-
-
-#### `get-property`
-
-Get the value for a specified configuration property.
-
-```bash
-default(localhost)> config get-property -p webServiceUrl mycluster
-```
-
-Options
-
-| Flag | Description | Default |
-|--------------------|-----------------------------|-----------------|
-| `-p`, `--property` | Property name to update. | |
-
-
-#### `view`
-
-View details of a config.
-
-```bash
-default(localhost)> config view mycluster
-```
-
-#### `delete`
-
-Delete a config. You can't delete a config if it's currently used.
-
-```bash
-default(localhost)> config delete mycluster
-```
-
-
-#### `list`
-
-List all the configuration names.
-
-```bash
-default(localhost)> config list
-```
\ No newline at end of file
