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/05/18 04:20:36 UTC
[pulsar] 02/02: [feature][website]feat: website preview script
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch fix/website-migrate-new-syntax
in repository https://gitbox.apache.org/repos/asf/pulsar.git
commit 01523f7f9d031a7de7b37cbdc0cf71d78eaf14a8
Author: Li Li <ur...@apache.org>
AuthorDate: Wed May 18 12:20:18 2022 +0800
[feature][website]feat: website preview script
Signed-off-by: Li Li <ur...@apache.org>
---
site2/.gitignore | 4 +-
site2/website/sidebars.json | 392 ++++++++++++++++++++++++++------------------
site2/website/start.sh | 15 ++
3 files changed, 246 insertions(+), 165 deletions(-)
diff --git a/site2/.gitignore b/site2/.gitignore
index f7825d3d6d2..db19afe98ef 100644
--- a/site2/.gitignore
+++ b/site2/.gitignore
@@ -15,4 +15,6 @@ website/static/swagger/master/*
website/static/swagger/restApiVersions.json
website/static/swagger/*/v*/*.json
-website-tmp*/
\ No newline at end of file
+website-tmp*/
+
+.preview/
\ No newline at end of file
diff --git a/site2/website/sidebars.json b/site2/website/sidebars.json
index c1c42da3a41..ece42103e00 100644
--- a/site2/website/sidebars.json
+++ b/site2/website/sidebars.json
@@ -1,166 +1,230 @@
{
- "docs": {
- "Get Started": [
- "getting-started-standalone",
- "getting-started-docker",
- "getting-started-helm"
- ],
- "Concepts and Architecture": [
- "concepts-overview",
- "concepts-messaging",
- "concepts-architecture-overview",
- "concepts-clients",
- "concepts-replication",
- "concepts-multi-tenancy",
- "concepts-authentication",
- "concepts-topic-compaction",
- "concepts-proxy-sni-routing",
- "concepts-multiple-advertised-listeners"
- ],
- "Pulsar Schema": [
- "schema-get-started",
- "schema-understand",
- "schema-evolution-compatibility",
- "schema-manage"
- ],
- "Pulsar Functions": [
- "functions-overview",
- "functions-runtime",
- "functions-worker",
- "functions-develop",
- "functions-package",
- "functions-debug",
- "functions-deploy",
- "functions-cli",
- "window-functions-context"
- ],
- "Pulsar IO": [
- "io-overview",
- "io-quickstart",
- "io-use",
- "io-debug",
- "io-connectors",
- "io-cdc",
- "io-develop",
- "io-cli"
- ],
- "Pulsar SQL": [
- "sql-overview",
- "sql-getting-started",
- "sql-deployment-configurations",
- "sql-rest-api"
- ],
- "Tiered Storage": [
- "tiered-storage-overview",
- "tiered-storage-aws",
- "tiered-storage-gcs",
- "tiered-storage-filesystem",
- "tiered-storage-azure",
- "tiered-storage-aliyun"
- ],
- "Transactions": [
- "txn-why",
- "txn-what",
- "txn-how",
- "txn-use",
- "txn-monitor"
- ],
- "Kubernetes (Helm)": [
- "helm-overview",
- "helm-prepare",
- "helm-install",
- "helm-deploy",
- "helm-upgrade",
- "helm-tools"
- ],
- "Deployment": [
- "deploy-aws",
- "deploy-kubernetes",
- "deploy-bare-metal",
- "deploy-bare-metal-multi-cluster",
- "deploy-dcos",
- "deploy-docker",
- "deploy-monitoring"
- ],
- "Administration": [
- "administration-zk-bk",
- "administration-geo",
- "administration-pulsar-manager",
- "administration-stats",
- "administration-load-balance",
- "administration-proxy",
- "administration-upgrade",
- "administration-isolation"
- ],
- "Security": [
- "security-overview",
- "security-policy-and-supported-versions",
- "security-tls-transport",
- "security-tls-authentication",
- "security-tls-keystore",
- "security-jwt",
- "security-athenz",
- "security-kerberos",
- "security-oauth2",
- "security-authorization",
- "security-encryption",
- "security-extending",
- "security-bouncy-castle"
- ],
- "Performance": [
- "performance-pulsar-perf"
- ],
- "Client Libraries": [
- "client-libraries",
- "client-libraries-java",
- "client-libraries-go",
- "client-libraries-python",
- "client-libraries-cpp",
- "client-libraries-node",
- "client-libraries-websocket",
- "client-libraries-dotnet",
- "client-libraries-rest"
- ],
- "Admin API": [
- "admin-api-overview",
- "admin-api-clusters",
- "admin-api-tenants",
- "admin-api-brokers",
- "admin-api-namespaces",
- "admin-api-permissions",
- "admin-api-topics",
- "admin-api-functions",
- "admin-api-packages"
- ],
- "Adaptors": [
- "adaptors-kafka",
- "adaptors-spark",
- "adaptors-storm"
- ],
- "Cookbooks": [
- "cookbooks-compaction",
- "cookbooks-deduplication",
- "cookbooks-non-persistent",
- "cookbooks-retention-expiry",
- "cookbooks-encryption",
- "cookbooks-message-queue",
- "cookbooks-bookkeepermetadata"
- ],
- "Development": [
- "develop-tools",
- "developing-binary-protocol",
- "develop-schema",
- "develop-load-manager",
- "develop-plugin"
- ],
- "Reference": [
- "reference-terminology",
- "reference-cli-tools",
- "reference-configuration",
- "reference-metrics"
- ]
- },
- "docs-other": {
- "First Category": ["doc4", "doc5"]
- }
+ "docsSidebar": [
+ {
+ "type": "doc",
+ "id": "about"
+ },
+ {
+ "type": "category",
+ "label": "Get Started",
+ "items": [
+ "getting-started-standalone",
+ "getting-started-docker",
+ "getting-started-helm"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Concepts and Architecture",
+ "items": [
+ "concepts-overview",
+ "concepts-messaging",
+ "concepts-architecture-overview",
+ "concepts-clients",
+ "concepts-replication",
+ "concepts-multi-tenancy",
+ "concepts-authentication",
+ "concepts-topic-compaction",
+ "concepts-proxy-sni-routing",
+ "concepts-multiple-advertised-listeners"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Pulsar Schema",
+ "items": [
+ "schema-get-started",
+ "schema-understand",
+ "schema-evolution-compatibility",
+ "schema-manage"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Pulsar Functions",
+ "items": [
+ "functions-overview",
+ "functions-runtime",
+ "functions-worker",
+ "functions-develop",
+ "functions-package",
+ "functions-debug",
+ "functions-deploy",
+ "functions-cli",
+ "window-functions-context"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Pulsar IO",
+ "items": [
+ "io-overview",
+ "io-quickstart",
+ "io-use",
+ "io-debug",
+ "io-connectors",
+ "io-cdc",
+ "io-develop",
+ "io-cli"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Pulsar SQL",
+ "items": [
+ "sql-overview",
+ "sql-getting-started",
+ "sql-deployment-configurations",
+ "sql-rest-api"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Tiered Storage",
+ "items": [
+ "tiered-storage-overview",
+ "tiered-storage-aws",
+ "tiered-storage-gcs",
+ "tiered-storage-filesystem",
+ "tiered-storage-azure",
+ "tiered-storage-aliyun"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Transactions",
+ "items": ["txn-why", "txn-what", "txn-how", "txn-use", "txn-monitor"]
+ },
+ {
+ "type": "category",
+ "label": "Kubernetes (Helm)",
+ "items": [
+ "helm-overview",
+ "helm-prepare",
+ "helm-install",
+ "helm-deploy",
+ "helm-upgrade",
+ "helm-tools"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Deployment",
+ "items": [
+ "deploy-aws",
+ "deploy-kubernetes",
+ "deploy-bare-metal",
+ "deploy-bare-metal-multi-cluster",
+ "deploy-docker",
+ "deploy-monitoring"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Administration",
+ "items": [
+ "administration-zk-bk",
+ "administration-geo",
+ "administration-pulsar-manager",
+ "administration-stats",
+ "administration-load-balance",
+ "administration-proxy",
+ "administration-upgrade",
+ "administration-isolation"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Security",
+ "items": [
+ "security-overview",
+ "security-policy-and-supported-versions",
+ "security-tls-transport",
+ "security-tls-authentication",
+ "security-tls-keystore",
+ "security-jwt",
+ "security-athenz",
+ "security-kerberos",
+ "security-oauth2",
+ "security-authorization",
+ "security-encryption",
+ "security-extending",
+ "security-bouncy-castle"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Performance",
+ "items": ["performance-pulsar-perf"]
+ },
+ {
+ "type": "category",
+ "label": "Client Libraries",
+ "items": [
+ "client-libraries",
+ "client-libraries-java",
+ "client-libraries-go",
+ "client-libraries-python",
+ "client-libraries-cpp",
+ "client-libraries-node",
+ "client-libraries-websocket",
+ "client-libraries-dotnet",
+ "client-libraries-rest"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Admin API",
+ "items": [
+ "admin-api-overview",
+ "admin-api-clusters",
+ "admin-api-tenants",
+ "admin-api-brokers",
+ "admin-api-namespaces",
+ "admin-api-permissions",
+ "admin-api-topics",
+ "admin-api-functions",
+ "admin-api-packages"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Adaptors",
+ "items": ["adaptors-kafka", "adaptors-spark", "adaptors-storm"]
+ },
+ {
+ "type": "category",
+ "label": "Cookbooks",
+ "items": [
+ "cookbooks-compaction",
+ "cookbooks-deduplication",
+ "cookbooks-non-persistent",
+ "cookbooks-retention-expiry",
+ "cookbooks-encryption",
+ "cookbooks-message-queue",
+ "cookbooks-bookkeepermetadata"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Development",
+ "items": [
+ "develop-tools",
+ "developing-binary-protocol",
+ "develop-load-manager",
+ "develop-plugin"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Reference",
+ "items": [
+ "reference-terminology",
+ "reference-cli-tools",
+ "reference-configuration",
+ "reference-metrics",
+ "reference-rest-api-overview"
+ ]
+ }
+ ]
}
diff --git a/site2/website/start.sh b/site2/website/start.sh
new file mode 100755
index 00000000000..6c8c6aff854
--- /dev/null
+++ b/site2/website/start.sh
@@ -0,0 +1,15 @@
+#! /bin/sh
+ROOT_DIR=$(git rev-parse --show-toplevel)
+cd $ROOT_DIR/site2/
+mkdir -p .preview
+cd .preview
+
+if [ -d "$ROOT_DIR/site2/.preview/pulsar-site" ]; then
+ git pull origin main
+else
+ git clone -b main --depth 1 https://github.com/apache/pulsar-site.git
+fi
+
+cd $ROOT_DIR/site2/.preview/pulsar-site/site2/website-next
+sh scripts/sync-docs.sh pulsar
+sh preview.sh $@
\ No newline at end of file