You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by li...@apache.org on 2022/09/11 12:38:00 UTC

[pulsar-site] branch main updated: add scripts for client config docs gen (#176)

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 4cda303f66f add scripts for client config docs gen (#176)
4cda303f66f is described below

commit 4cda303f66fe4329a04b34cf1eedb5e4435063e5
Author: Mercurio <32...@users.noreply.github.com>
AuthorDate: Sun Sep 11 20:37:54 2022 +0800

    add scripts for client config docs gen (#176)
---
 site2/tools/pulsar-config-doc-gen.sh | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/site2/tools/pulsar-config-doc-gen.sh b/site2/tools/pulsar-config-doc-gen.sh
index e68ff6249eb..b9e4f38df36 100755
--- a/site2/tools/pulsar-config-doc-gen.sh
+++ b/site2/tools/pulsar-config-doc-gen.sh
@@ -18,17 +18,24 @@
 # under the License.
 #
 
-set -x
-
+# common variables
 ROOT_DIR=$(git rev-parse --show-toplevel)
 WEBSITE=$1
-DOCS_DIR=$WEBSITE/docsify/config
-
 JAVA=java
 f=$ROOT_DIR/distribution/server/target/classpath.txt
+
+# config doc gen variables
+DOCS_DIR=$WEBSITE/docsify/config
 GEN_DOCS_BROKER=org.apache.pulsar.utils.CmdGenerateDocumentation
 GEN_DOCS_PROXY=org.apache.pulsar.proxy.util.CmdGenerateDocumentation
 
+# client config doc gen variables
+CLIENT_DIR=$WEBSITE/docsify/client
+CLIENT_CP=$ROOT_DIR/pulsar-client/target/classes
+CLIENT_CONF=org.apache.pulsar.client.impl.conf
+GEN_DOCS_CLIENT=$CLINET_CONF.CmdGenerateDocumentation
+
+# config doc gen
 cp $WEBSITE/docs/reference-configuration*.md $DOCS_DIR
 
 $JAVA -cp "$(cat $f)" $GEN_DOCS_BROKER -c org.apache.pulsar.broker.ServiceConfiguration > $DOCS_DIR/reference-configuration-broker.md
@@ -37,3 +44,9 @@ $JAVA -cp "$(cat $f)" $GEN_DOCS_BROKER -c org.apache.pulsar.websocket.service.We
 $JAVA -cp "$(cat $f)" $GEN_DOCS_PROXY -c org.apache.pulsar.proxy.server.ProxyConfiguration > $DOCS_DIR/reference-configuration-pulsar-proxy.md
 
 cp $DOCS_DIR/reference-configuration-broker.md $DOCS_DIR/reference-configuration-standalone.md
+
+# client config doc gen
+$JAVA -cp $CLIENT_CP:"$(cat $f)" $GEN_DOCS_CLIENT -c $CLIENT_CONF.ClientConfigurationData > $CLIENT_DIR/client-configuration-client.md
+$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