You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ur...@apache.org on 2022/06/01 04:12:02 UTC

[pulsar-site] branch fix/scripts-optimize updated: update scripts

This is an automated email from the ASF dual-hosted git repository.

urfree pushed a commit to branch fix/scripts-optimize
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git


The following commit(s) were added to refs/heads/fix/scripts-optimize by this push:
     new ba349fc1d64 update scripts
ba349fc1d64 is described below

commit ba349fc1d6444099e8e60f670dcf2986616f652e
Author: Li Li <ur...@apache.org>
AuthorDate: Wed Jun 1 12:11:56 2022 +0800

    update scripts
    
    Signed-off-by: Li Li <ur...@apache.org>
---
 site2/tools/pulsar-admin-doc-gen.sh                | 20 +--------------
 ...{pulsar-admin-doc-gen.sh => pulsar-admin-md.sh} | 29 ++--------------------
 site2/tools/pulsar-client-doc-gen.sh               |  2 +-
 site2/tools/pulsar-client-md.sh                    | 28 +++++++++++++++++++++
 site2/tools/pulsar-doc-gen.sh                      | 14 +----------
 site2/tools/{pulsar-doc-gen.sh => pulsar-md.sh}    | 29 ++--------------------
 site2/tools/pulsar-perf-doc-gen.sh                 |  2 +-
 site2/tools/pulsar-perf-md.sh                      | 28 +++++++++++++++++++++
 8 files changed, 64 insertions(+), 88 deletions(-)

diff --git a/site2/tools/pulsar-admin-doc-gen.sh b/site2/tools/pulsar-admin-doc-gen.sh
index c86cc53fe01..3eb462d7e7f 100755
--- a/site2/tools/pulsar-admin-doc-gen.sh
+++ b/site2/tools/pulsar-admin-doc-gen.sh
@@ -27,26 +27,8 @@ cd $ROOT_DIR
 
 mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}
 mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules
-mkdir -p $ROOT_DIR/site2/${WEBSITE}/brodocs/documents
 
-$ROOT_DIR/bin/pulsar-admin documents generate broker-stats > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/broker-stats.md
-$ROOT_DIR/bin/pulsar-admin documents generate brokers > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/brokers.md
-$ROOT_DIR/bin/pulsar-admin documents generate clusters > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/clusters.md
-$ROOT_DIR/bin/pulsar-admin documents generate functions > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/functions.md
-$ROOT_DIR/bin/pulsar-admin documents generate functions-worker > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/functions-worker.md
-$ROOT_DIR/bin/pulsar-admin documents generate namespaces > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/namespaces.md
-$ROOT_DIR/bin/pulsar-admin documents generate ns-isolation-policy > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/ns-isolation-policy.md
-$ROOT_DIR/bin/pulsar-admin documents generate sources > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/sources.md
-$ROOT_DIR/bin/pulsar-admin documents generate sinks > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/sinks.md
-$ROOT_DIR/bin/pulsar-admin documents generate topics > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/topics.md
-$ROOT_DIR/bin/pulsar-admin documents generate topicPolicies > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/topicPolicies.md
-$ROOT_DIR/bin/pulsar-admin documents generate proxy-stats > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/proxy-stats.md
-$ROOT_DIR/bin/pulsar-admin documents generate resourcegroups > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/resourcegroups.md
-$ROOT_DIR/bin/pulsar-admin documents generate transactions > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/transactions.md
-$ROOT_DIR/bin/pulsar-admin documents generate tenants > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/tenants.md
-$ROOT_DIR/bin/pulsar-admin documents generate resource-quotas > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/resource-quotas.md
-$ROOT_DIR/bin/pulsar-admin documents generate schemas > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/schemas.md
-$ROOT_DIR/bin/pulsar-admin documents generate packages > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/packages.md
+${ROOT_DIR}/site2/tools/pulsar-admin-md.sh $ROOT_DIR $WEBSITE
 
 cd $ROOT_DIR/site2/${WEBSITE}/brodocs
 cp pulsar-admin-manifest.json manifest.json
diff --git a/site2/tools/pulsar-admin-doc-gen.sh b/site2/tools/pulsar-admin-md.sh
similarity index 63%
copy from site2/tools/pulsar-admin-doc-gen.sh
copy to site2/tools/pulsar-admin-md.sh
index c86cc53fe01..7a09a73f195 100755
--- a/site2/tools/pulsar-admin-doc-gen.sh
+++ b/site2/tools/pulsar-admin-md.sh
@@ -18,15 +18,11 @@
 # under the License.
 #
 
-ROOT_DIR=$(git rev-parse --show-toplevel)
-VERSION=`${ROOT_DIR}/src/get-project-version.py`
-DEST_DIR=$ROOT_DIR/generated-site
-WEBSITE=$1
+ROOT_DIR=$1
+WEBSITE=$2
 
 cd $ROOT_DIR
 
-mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}
-mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules
 mkdir -p $ROOT_DIR/site2/${WEBSITE}/brodocs/documents
 
 $ROOT_DIR/bin/pulsar-admin documents generate broker-stats > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/broker-stats.md
@@ -47,24 +43,3 @@ $ROOT_DIR/bin/pulsar-admin documents generate tenants > $ROOT_DIR/site2/${WEBSIT
 $ROOT_DIR/bin/pulsar-admin documents generate resource-quotas > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/resource-quotas.md
 $ROOT_DIR/bin/pulsar-admin documents generate schemas > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/schemas.md
 $ROOT_DIR/bin/pulsar-admin documents generate packages > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/packages.md
-
-cd $ROOT_DIR/site2/${WEBSITE}/brodocs
-cp pulsar-admin-manifest.json manifest.json
-node brodoc.js
-
-cp index.html $DEST_DIR/tools/pulsar-admin/${VERSION}/
-cp navData.js stylesheet.css $DEST_DIR/tools/pulsar-admin/${VERSION}/
-cp scroll.js tabvisibility.js $DEST_DIR/tools/pulsar-admin/${VERSION}/
-cp favicon.ico $DEST_DIR/tools/pulsar-admin/${VERSION}/
-mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/bootstrap/dist/css
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/bootstrap/dist/css/bootstrap.min.css $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/bootstrap/dist/css
-mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/font-awesome/css
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/font-awesome/css/font-awesome.min.css $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/font-awesome/css
-mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/highlight.js/styles
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/highlight.js/styles/default.css $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/highlight.js/styles
-mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/jquery/dist
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/jquery/dist/jquery.min.js $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/jquery/dist/
-mkdir -p $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/jquery.scrollto
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/jquery.scrollto/jquery.scrollTo.min.js $DEST_DIR/tools/pulsar-admin/${VERSION}/node_modules/jquery.scrollto
-
-
diff --git a/site2/tools/pulsar-client-doc-gen.sh b/site2/tools/pulsar-client-doc-gen.sh
index 1acf5333acf..6e92d375494 100755
--- a/site2/tools/pulsar-client-doc-gen.sh
+++ b/site2/tools/pulsar-client-doc-gen.sh
@@ -29,7 +29,7 @@ mkdir -p $DEST_DIR/tools/pulsar-client/${VERSION}
 mkdir -p $DEST_DIR/tools/pulsar-client/${VERSION}/node_modules
 mkdir -p $ROOT_DIR/site2/${WEBSITE}/brodocs/documents
 
-$ROOT_DIR/bin/pulsar-client generate_documentation > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/pulsar-client.md
+${ROOT_DIR}/site2/tools/pulsar-client-md.sh $ROOT_DIR $WEBSITE
 
 cd $ROOT_DIR/site2/${WEBSITE}/brodocs
 cp pulsar-client-manifest.json manifest.json
diff --git a/site2/tools/pulsar-client-md.sh b/site2/tools/pulsar-client-md.sh
new file mode 100755
index 00000000000..44b4ffb908b
--- /dev/null
+++ b/site2/tools/pulsar-client-md.sh
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+ROOT_DIR=$1
+WEBSITE=$2
+
+cd $ROOT_DIR
+
+mkdir -p $ROOT_DIR/site2/${WEBSITE}/brodocs/documents
+
+$ROOT_DIR/bin/pulsar-client generate_documentation > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/pulsar-client.md
\ No newline at end of file
diff --git a/site2/tools/pulsar-doc-gen.sh b/site2/tools/pulsar-doc-gen.sh
index 3468ea6c902..5140dfe85d1 100755
--- a/site2/tools/pulsar-doc-gen.sh
+++ b/site2/tools/pulsar-doc-gen.sh
@@ -29,19 +29,7 @@ mkdir -p $DEST_DIR/tools/pulsar/${VERSION}
 mkdir -p $DEST_DIR/tools/pulsar/${VERSION}/node_modules
 mkdir -p $ROOT_DIR/site2/${WEBSITE}/brodocs/documents
 
-$ROOT_DIR/bin/pulsar broker -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/broker.md
-$ROOT_DIR/bin/pulsar broker-tool gen-doc > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/broker-tool.md
-$ROOT_DIR/bin/pulsar compact-topic -t tmp -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/compact-topic.md
-$ROOT_DIR/bin/pulsar tokens gen-doc > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/tokens.md
-$ROOT_DIR/bin/pulsar proxy -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/proxy.md
-$ROOT_DIR/bin/pulsar functions-worker -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/functions-worker.md
-$ROOT_DIR/bin/pulsar standalone -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/standalone.md
-$ROOT_DIR/bin/pulsar initialize-cluster-metadata -cs cs -uw uw -zk zk -c c -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/initialize-cluster-metadata.md
-$ROOT_DIR/bin/pulsar delete-cluster-metadata -zk zk -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/delete-cluster-metadata.md
-$ROOT_DIR/bin/pulsar initialize-transaction-coordinator-metadata -cs cs -c c -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/initialize-transaction-coordinator-metadata.md
-$ROOT_DIR/bin/pulsar initialize-namespace -cs cs -c c -g demo > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/initialize-namespace.md
-$ROOT_DIR/bin/pulsar version -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/version.md
-$ROOT_DIR/bin/pulsar websocket -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/websocket.md
+${ROOT_DIR}/site2/tools/pulsar-md.sh $ROOT_DIR $WEBSITE
 
 cd $ROOT_DIR/site2/${WEBSITE}/brodocs
 cp pulsar-manifest.json manifest.json
diff --git a/site2/tools/pulsar-doc-gen.sh b/site2/tools/pulsar-md.sh
similarity index 58%
copy from site2/tools/pulsar-doc-gen.sh
copy to site2/tools/pulsar-md.sh
index 3468ea6c902..857c8a33d6b 100755
--- a/site2/tools/pulsar-doc-gen.sh
+++ b/site2/tools/pulsar-md.sh
@@ -18,15 +18,11 @@
 # under the License.
 #
 
-ROOT_DIR=$(git rev-parse --show-toplevel)
-VERSION=`${ROOT_DIR}/src/get-project-version.py`
-DEST_DIR=$ROOT_DIR/generated-site
-WEBSITE=$1
+ROOT_DIR=$1
+WEBSITE=$2
 
 cd $ROOT_DIR
 
-mkdir -p $DEST_DIR/tools/pulsar/${VERSION}
-mkdir -p $DEST_DIR/tools/pulsar/${VERSION}/node_modules
 mkdir -p $ROOT_DIR/site2/${WEBSITE}/brodocs/documents
 
 $ROOT_DIR/bin/pulsar broker -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/broker.md
@@ -42,24 +38,3 @@ $ROOT_DIR/bin/pulsar initialize-transaction-coordinator-metadata -cs cs -c c -g
 $ROOT_DIR/bin/pulsar initialize-namespace -cs cs -c c -g demo > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/initialize-namespace.md
 $ROOT_DIR/bin/pulsar version -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/version.md
 $ROOT_DIR/bin/pulsar websocket -g > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/websocket.md
-
-cd $ROOT_DIR/site2/${WEBSITE}/brodocs
-cp pulsar-manifest.json manifest.json
-node brodoc.js
-
-cp index.html $DEST_DIR/tools/pulsar/${VERSION}/
-cp navData.js stylesheet.css $DEST_DIR/tools/pulsar/${VERSION}/
-cp scroll.js tabvisibility.js $DEST_DIR/tools/pulsar/${VERSION}/
-cp favicon.ico $DEST_DIR/tools/pulsar/${VERSION}/
-mkdir -p $DEST_DIR/tools/pulsar/${VERSION}/node_modules/bootstrap/dist/css
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/bootstrap/dist/css/bootstrap.min.css $DEST_DIR/tools/pulsar/${VERSION}/node_modules/bootstrap/dist/css
-mkdir -p $DEST_DIR/tools/pulsar/${VERSION}/node_modules/font-awesome/css
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/font-awesome/css/font-awesome.min.css $DEST_DIR/tools/pulsar/${VERSION}/node_modules/font-awesome/css
-mkdir -p $DEST_DIR/tools/pulsar/${VERSION}/node_modules/highlight.js/styles
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/highlight.js/styles/default.css $DEST_DIR/tools/pulsar/${VERSION}/node_modules/highlight.js/styles
-mkdir -p $DEST_DIR/tools/pulsar/${VERSION}/node_modules/jquery/dist
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/jquery/dist/jquery.min.js $DEST_DIR/tools/pulsar/${VERSION}/node_modules/jquery/dist/
-mkdir -p $DEST_DIR/tools/pulsar/${VERSION}/node_modules/jquery.scrollto
-cp -r $ROOT_DIR/site2/${WEBSITE}/node_modules/jquery.scrollto/jquery.scrollTo.min.js $DEST_DIR/tools/pulsar/${VERSION}/node_modules/jquery.scrollto
-
-
diff --git a/site2/tools/pulsar-perf-doc-gen.sh b/site2/tools/pulsar-perf-doc-gen.sh
index cc8b30c31be..9cdbc0f08d0 100755
--- a/site2/tools/pulsar-perf-doc-gen.sh
+++ b/site2/tools/pulsar-perf-doc-gen.sh
@@ -29,7 +29,7 @@ mkdir -p $DEST_DIR/tools/pulsar-perf/${VERSION}
 mkdir -p $DEST_DIR/tools/pulsar-perf/${VERSION}/node_modules
 mkdir -p $ROOT_DIR/site2/${WEBSITE}/brodocs/documents
 
-$ROOT_DIR/bin/pulsar-perf gen-doc > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/pulsar-perf.md
+${ROOT_DIR}/site2/tools/pulsar-perf-md.sh $ROOT_DIR $WEBSITE
 
 cd $ROOT_DIR/site2/${WEBSITE}/brodocs
 cp pulsar-perf-manifest.json manifest.json
diff --git a/site2/tools/pulsar-perf-md.sh b/site2/tools/pulsar-perf-md.sh
new file mode 100755
index 00000000000..f9bc9b60b87
--- /dev/null
+++ b/site2/tools/pulsar-perf-md.sh
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+ROOT_DIR=$1
+WEBSITE=$2
+
+cd $ROOT_DIR
+
+mkdir -p $ROOT_DIR/site2/${WEBSITE}/brodocs/documents
+
+$ROOT_DIR/bin/pulsar-perf gen-doc > $ROOT_DIR/site2/${WEBSITE}/brodocs/documents/pulsar-perf.md