From 83b611087b3c6f9ab1afde86ed9668ac8e152c8c Mon Sep 17 00:00:00 2001 From: LiLi Date: Tue, 6 Jul 2021 16:57:39 +0800 Subject: [PATCH 1/3] [website][pulsar]generate html pages for pulsar command Signed-off-by: LiLi --- site2/tools/pulsar-doc-gen.sh | 55 ++++++++++++++++++++++ site2/website/brodocs/pulsar-manifest.json | 18 +++++++ 2 files changed, 73 insertions(+) create mode 100755 site2/tools/pulsar-doc-gen.sh create mode 100644 site2/website/brodocs/pulsar-manifest.json diff --git a/site2/tools/pulsar-doc-gen.sh b/site2/tools/pulsar-doc-gen.sh new file mode 100755 index 0000000000000..d64be66e09c27 --- /dev/null +++ b/site2/tools/pulsar-doc-gen.sh @@ -0,0 +1,55 @@ +#!/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=$(git rev-parse --show-toplevel) +VERSION=`${ROOT_DIR}/src/get-project-version.py` +DEST_DIR=$ROOT_DIR/generated-site + +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 +$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 + +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/website/brodocs/pulsar-manifest.json b/site2/website/brodocs/pulsar-manifest.json new file mode 100644 index 0000000000000..586714e11ce33 --- /dev/null +++ b/site2/website/brodocs/pulsar-manifest.json @@ -0,0 +1,18 @@ +{ + "docs": [ + { + "filename": "broker.md" + }, + { + "filename": "broker-tool.md" + }, + { + "filename": "compact-topic.md" + }, + { + "filename": "tokens.md" + } + ], + "title": "Docs", + "copyright": "Apache Pulsar" +} From 29440b9ee4cd4169d7e0fd6713232d1cfaccd073 Mon Sep 17 00:00:00 2001 From: LiLi Date: Fri, 9 Jul 2021 18:10:24 +0800 Subject: [PATCH 2/3] [website][pulsar] pulsar docs enter-link Signed-off-by: LiLi --- site2/tools/build-site.sh | 1 + site2/website/pages/en/pulsar-cli.js | 24 ++++++++++++++++++++++ site2/website/pages/en/pulsar-perf-cli.js | 4 ++-- site2/website/static/js/custom.js | 1 + site2/website/static/js/getCliByVersion.js | 3 +++ 5 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 site2/website/pages/en/pulsar-cli.js diff --git a/site2/tools/build-site.sh b/site2/tools/build-site.sh index da4ffdac08079..7bd3bae4fa493 100755 --- a/site2/tools/build-site.sh +++ b/site2/tools/build-site.sh @@ -98,6 +98,7 @@ node ./scripts/split-swagger-by-version.js ${ROOT_DIR}/site2/tools/pulsar-admin-doc-gen.sh ${ROOT_DIR}/site2/tools/pulsar-client-doc-gen.sh ${ROOT_DIR}/site2/tools/pulsar-perf-doc-gen.sh +${ROOT_DIR}/site2/tools/pulsar-doc-gen.sh cd ${ROOT_DIR}/site2/website rm -rf ${ROOT_DIR}/generated-site/content diff --git a/site2/website/pages/en/pulsar-cli.js b/site2/website/pages/en/pulsar-cli.js new file mode 100644 index 0000000000000..388726e777036 --- /dev/null +++ b/site2/website/pages/en/pulsar-cli.js @@ -0,0 +1,24 @@ +const React = require('react'); +const CompLibrary = require('../../core/CompLibrary.js'); + +const Container = CompLibrary.Container; +const CWD = process.cwd(); +const releases = require(`${CWD}/releases.json`); + +class PulsarCli extends React.Component { + render() { + const latestVersion = releases[0]; + const url = "../js/getCliByVersion.js?latestVersion=" + latestVersion; + return ( +
+ + {latestVersion} + pulsar + + +
+ ); + } +} + +module.exports = PulsarCli; diff --git a/site2/website/pages/en/pulsar-perf-cli.js b/site2/website/pages/en/pulsar-perf-cli.js index b1e5f243b4357..e6eaaaace0c67 100644 --- a/site2/website/pages/en/pulsar-perf-cli.js +++ b/site2/website/pages/en/pulsar-perf-cli.js @@ -5,7 +5,7 @@ const Container = CompLibrary.Container; const CWD = process.cwd(); const releases = require(`${CWD}/releases.json`); -class PulsarClientCli extends React.Component { +class PulsarPerfCli extends React.Component { render() { const latestVersion = releases[0]; const url = "../js/getCliByVersion.js?latestVersion=" + latestVersion; @@ -21,4 +21,4 @@ class PulsarClientCli extends React.Component { } } -module.exports = PulsarClientCli; +module.exports = PulsarPerfCli; diff --git a/site2/website/static/js/custom.js b/site2/website/static/js/custom.js index 4c8ad53cd9e09..84d3c7daafe78 100644 --- a/site2/website/static/js/custom.js +++ b/site2/website/static/js/custom.js @@ -116,6 +116,7 @@ window.addEventListener('load', function () { '
  • Pulsar Admin
    • ' + '
  • Pulsar Client
    • ' + '
  • Pulsar Perf
    • ' + + '
  • Pulsar
    • ' + '' + '' + ''; diff --git a/site2/website/static/js/getCliByVersion.js b/site2/website/static/js/getCliByVersion.js index f23c30266ffe0..7f3ab5d4ff49e 100644 --- a/site2/website/static/js/getCliByVersion.js +++ b/site2/website/static/js/getCliByVersion.js @@ -30,6 +30,9 @@ function getCliByVersion(){ } else if(clientModule === "pulsar-perf") { minMinorVersion = 8 referenceLink = "/reference-cli-tools/#pulsar-perf" + } else if(clientModule === "pulsar") { + minMinorVersion = 8 + referenceLink = "/reference-cli-tools/#pulsar" } if ((majorVersion > 1 && minorVersion <= minMinorVersion) || majorVersion === 1) { if (version === latestVersion) { From 136747bf1671e2bc4ff408611a99690472f8e81e Mon Sep 17 00:00:00 2001 From: LiLi Date: Thu, 15 Jul 2021 18:14:04 +0800 Subject: [PATCH 3/3] [website][pulsar]: auto generate html for pulsar subcommands Signed-off-by: LiLi --- site2/tools/pulsar-doc-gen.sh | 10 ++++++++ site2/website/brodocs/pulsar-manifest.json | 30 ++++++++++++++++++++++ 2 files changed, 40 insertions(+) diff --git a/site2/tools/pulsar-doc-gen.sh b/site2/tools/pulsar-doc-gen.sh index d64be66e09c27..26517880f622a 100755 --- a/site2/tools/pulsar-doc-gen.sh +++ b/site2/tools/pulsar-doc-gen.sh @@ -32,6 +32,16 @@ $ROOT_DIR/bin/pulsar broker -g > $ROOT_DIR/site2/website/brodocs/documents/broke $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 discovery -g > $ROOT_DIR/site2/website/brodocs/documents/discovery.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 diff --git a/site2/website/brodocs/pulsar-manifest.json b/site2/website/brodocs/pulsar-manifest.json index 586714e11ce33..6f4b73bf606d7 100644 --- a/site2/website/brodocs/pulsar-manifest.json +++ b/site2/website/brodocs/pulsar-manifest.json @@ -11,6 +11,36 @@ }, { "filename": "tokens.md" + }, + { + "filename": "discovery.md" + }, + { + "filename": "proxy.md" + }, + { + "filename": "websocket.md" + }, + { + "filename": "functions-worker.md" + }, + { + "filename": "standalone.md" + }, + { + "filename": "initialize-cluster-metadata.md" + }, + { + "filename": "delete-cluster-metadata.md" + }, + { + "filename": "initialize-transaction-coordinator-metadata.md" + }, + { + "filename": "initialize-namespace.md" + }, + { + "filename": "version.md" } ], "title": "Docs",