From 954d68e55b4c3c750fc36b9ff4637d721d655155 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 19 Jul 2022 16:38:40 +0800 Subject: [PATCH] release-3.2.0 (#1528) --- .github/workflows/deploy.yml | 12 +- .../dashboard-comm-release-note.md | 2 +- .../1.introduction-to-nebula-operator.md | 2 +- docs-2.0/stylesheets/extra.css | 4 +- mkdocs.yml | 108 +++++++++--------- 5 files changed, 66 insertions(+), 62 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index dded2b6b46e..238deb39e77 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -2,8 +2,7 @@ name: Publish docs via GitHub Pages on: push: branches: - # Remember to add v before the following version number unless the version is master. - - master + - v3.2.0 jobs: deploy: @@ -11,7 +10,7 @@ jobs: steps: - uses: actions/checkout@v2 with: - fetch-depth: 0 # fetch all commits/branches for gitversion + fetch-depth: 1 # fetch all commits/branches for gitversion - name: Setup Python uses: actions/setup-python@v1 @@ -25,11 +24,12 @@ jobs: - name: Git Config run: git config user.name whitewum && git config user.email min.wu@vesoft.com - - name: Mike Deploy master + - name: Mike Deploy 3.2.0 run: | - # mike delete master -p + # mike delete v3.2.0 -p mike list - mike deploy master -p --rebase + mike deploy 3.2.0 -p --rebase + mike set-default 3.2.0 -p --rebase mike list # - name: Deploy diff --git a/docs-2.0/20.appendix/release-notes/dashboard-comm-release-note.md b/docs-2.0/20.appendix/release-notes/dashboard-comm-release-note.md index 299ac9f41c1..715c2333879 100644 --- a/docs-2.0/20.appendix/release-notes/dashboard-comm-release-note.md +++ b/docs-2.0/20.appendix/release-notes/dashboard-comm-release-note.md @@ -1,6 +1,6 @@ # Nebula Dashboard Community Edition release notes -## Community Edition 3.0.0 +## Community Edition 3.1.0 - Feature - Support [deploying Nebula Dashboard with Docker Compose](../../nebula-dashboard/2.deploy-dashboard.md). diff --git a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md index cf0c30bae2e..45ed36c7a33 100644 --- a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md +++ b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md @@ -32,7 +32,7 @@ Nebula Operator does not support the v1.x version of Nebula Graph. Nebula Operat | Nebula Operator version | Nebula Graph version | | ------------------- | ---------------- | -| 1.1.0| 3.0.0 ~ 3.1.x | +| 1.2.0| 3.0.0 ~ 3.1.x | | 1.0.0| 3.0.0 ~ 3.1.x | | 0.9.0| 2.5.x ~ 2.6.x | |0.8.0|2.5.x| diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index 7680955d283..08ffda24047 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -10,8 +10,8 @@ /* nebula light */ [data-md-color-scheme="nebula"]{ - --md-primary-fg-color: #FF0000; /* Tar bar color */ - --md-accent-fg-color: #49BDF0; /* Selected color */ + --md-primary-fg-color: #F7A7A0; /* Tar bar color */ + --md-accent-fg-color: #7DBB7C; /* Selected color */ --md-code-fg-color: rgb(12, 21, 26); --md-code-bg-color: #eaebec; diff --git a/mkdocs.yml b/mkdocs.yml index 911823c348b..d19985b64af 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,7 @@ repo_url: 'https://github.com/vesoft-inc/nebula-docs' copyright: Copyright © 2022 Nebula Graph # modify -edit_uri: 'edit/master/docs-2.0/' +edit_uri: 'edit/v3.2.0/docs-2.0/' theme: name: material @@ -76,19 +76,19 @@ plugins: - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md - nebula-cloud/* # When publishing a version of a document that includes Enterprise Edition, annotation the following pages - # begin - - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md - - 4.deployment-and-installation/deploy-license.md - - 5.configurations-and-logs/2.log-management/audit-log.md - - 7.data-security/1.authentication/4.ldap.md - - graph-computing/0.deploy-controller-analytics.md - - graph-computing/nebula-analytics.md - - graph-computing/use-explorer.md - - nebula-exchange/use-exchange/ex-ug-export-from-nebula.md - - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md - - synchronization-and-migration/replication-between-clusters.md - - 20.appendix/8.about-license/ - # end + # # begin + # - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md + # - 4.deployment-and-installation/deploy-license.md + # - 5.configurations-and-logs/2.log-management/audit-log.md + # - 7.data-security/1.authentication/4.ldap.md + # - graph-computing/0.deploy-controller-analytics.md + # - graph-computing/nebula-analytics.md + # - graph-computing/use-explorer.md + # - nebula-exchange/use-exchange/ex-ug-export-from-nebula.md + # - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md + # - synchronization-and-migration/replication-between-clusters.md + # - 20.appendix/8.about-license/ + # # end # Exclude the file with the following file name. # - abc.md @@ -98,7 +98,7 @@ plugins: - with-pdf: copyright: 2022 Vesoft Inc. - cover_subtitle: master + cover_subtitle: v3.2.0 author: Min Wu, Yao Zhou, Cooper Liang, Foesa Yang, Abby Huang cover: true back_cover: true @@ -138,15 +138,19 @@ extra: - icon: 'fontawesome/brands/github' link: 'https://github.com/vesoft-inc/nebula-docs' nebula: - release: master + release: 3.2.0 nightly: nightly master: master base20: 2.0 base200: 2.0.0 - branch: master - tag: master + branch: release-3.2 + tag: v3.2.0 studio: + base111b: 1.1.1-beta + base220: 2.2.1 + base300: 3.0.0 release: 3.4.0 + branch: release-3.4 tag: v3.4.0 explorer: release: 3.1.0 @@ -161,9 +165,9 @@ extra: branch: v3.0.0 tag: v3.0.0 importer: - release: 3.1.0 - branch: release-3.1 - tag: v3.1.0 + release: 3.2.0 + branch: release-3.2 + tag: v3.2.0 algorithm: release: 3.0.0 branch: v3.0.0 @@ -189,26 +193,26 @@ extra: branch: release-3.2 tag: v3.2.0 dashboard: - release: 3.0.0 - tag: v3.0.0 + release: 3.1.0 + tag: v3.1.0 base100: 1.0.0 - branch: release-3.0 + branch: release-3.1 dashboard_ent: release: 3.1.0 tag: v3.1.0 branch: release-3.1 console: - release: 3.0.0 - branch: v3.0.0 - tag: v3.0.0 + release: 3.2.0 + branch: release-3.2 + tag: v3.2.0 br: release: 0.6.1 branch: master tag: v0.6.1 cpp: - release: 3.0.0 - branch: v3.0.0 - tag: v3.0.0 + release: 3.2.0 + branch: release-v3.2 + tag: v3.2.0 java: release: 3.0.0 branch: v3.0.0 @@ -218,27 +222,27 @@ extra: branch: release-3.1 tag: v3.1.0 go: - release: 3.1.0 - branch: release-3.1 - tag: v3.1.0 + release: 3.2.0 + branch: release-3.2 + tag: v3.2.0 bench: release: 1.2.0 branch: release-1.2 tag: v1.2.0 operator: - release: 1.1.0 - tag: v1.1.0 - branch: release-1.1 + release: 1.2.0 + tag: v1.2.0 + branch: release-1.2 upgrade_from: 3.0.0 upgrade_to: 3.1.x exporter: - release: 3.1.0 - branch: release-3.1 - tag: v3.1.0 + release: 3.2.0 + branch: release-3.2 + tag: v3.2.0 gateway: - release: 3.1.2 - branch: release-3.1 - tag: v3.1.2 + release: 3.2.0 + branch: release-3.2 + tag: v3.2.0 cloud: azureRelease: 3.1.1 # The latest core version that Azure Cloud is compatible with aliyunRelease: 3.1.1 # The latest core version that Alibaba Cloud is compatible with @@ -320,7 +324,7 @@ nav: - Conditional expressions: 3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md - Predicate functions: 3.ngql-guide/6.functions-and-expressions/8.predicate.md - Geography functions: 3.ngql-guide/6.functions-and-expressions/14.geo.md -#ent - Elasticsearch functions: 3.ngql-guide/6.functions-and-expressions/17.ES-function.md + - Elasticsearch functions: 3.ngql-guide/6.functions-and-expressions/17.ES-function.md - User-defined functions: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md - General queries statements: @@ -434,7 +438,7 @@ nav: - Deploy a Nebula Graph cluster on multiple servers: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md - Deploy Nebula Grpah with ecosystem tools: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md - Deploy standalone Nebula Graph: 4.deployment-and-installation/standalone-deployment.md -#ent - Deploy licenses for Nebula Graph Enterprise Edition clusters: 4.deployment-and-installation/deploy-license.md + - Deploy licenses for Nebula Graph Enterprise Edition clusters: 4.deployment-and-installation/deploy-license.md - Manage Service: 4.deployment-and-installation/manage-service.md - Connect to Service: 4.deployment-and-installation/connect-to-nebula-graph.md - Manage Storage host: 4.deployment-and-installation/manage-storage-host.md @@ -453,7 +457,7 @@ nav: - Kernel configurations: 5.configurations-and-logs/1.configurations/6.kernel-config.md - Log management: - Runtime logs: 5.configurations-and-logs/2.log-management/logs.md -#ent - Audit logs(Enterprise): 5.configurations-and-logs/2.log-management/audit-log.md + - Audit logs(Enterprise): 5.configurations-and-logs/2.log-management/audit-log.md - Monitor and metrics: - Query Nebula Graph metrics: 6.monitor-and-metrics/1.query-performance-metrics.md @@ -476,7 +480,7 @@ nav: - Synchronization & Migration: - Load balance: synchronization-and-migration/2.balance-syntax.md -#ent - Synchronize between two clusters: synchronization-and-migration/replication-between-clusters.md + - Synchronize between two clusters: synchronization-and-migration/replication-between-clusters.md - Practices: - Compaction: 8.service-tuning/compaction.md @@ -583,7 +587,7 @@ nav: - Start querying: nebula-explorer/graph-explorer/ex-ug-query-exploration.md - Vertex Filter: nebula-explorer/graph-explorer/node-filtering.md - Graph exploration: nebula-explorer/graph-explorer/ex-ug-graph-exploration.md -# - 图计算: nebula-explorer/graph-explorer/graph-algorithm.md + - Graph computing: nebula-explorer/graph-explorer/graph-algorithm.md - Visual query: nebula-explorer/12.query-visually.md - Canvas: - Canvas overview: nebula-explorer/canvas-operations/canvas-overview.md @@ -657,11 +661,11 @@ nav: - Nebula Algorithm: graph-computing/nebula-algorithm.md -#ent - Nebula Analytics: graph-computing/nebula-analytics.md + - Nebula Analytics: graph-computing/nebula-analytics.md -#ent - Nebula Explorer workflow: graph-computing/use-explorer.md + - Nebula Explorer workflow: graph-computing/use-explorer.md -#ent - Dag Controller: graph-computing/0.deploy-controller-analytics.md + - Dag Controller: graph-computing/0.deploy-controller-analytics.md - Nebula Spark Connector: nebula-spark-connector.md @@ -672,13 +676,13 @@ nav: - Appendix: - Release Note: - Nebula Graph Community Edition: 20.appendix/release-notes/nebula-comm-release-note.md -#ent - Nebula Graph Enterprise Edition: 20.appendix/release-notes/nebula-ent-release-note.md + - Nebula Graph Enterprise Edition: 20.appendix/release-notes/nebula-ent-release-note.md - Nebula Studio: 20.appendix/release-notes/studio-release-note.md - Nebula Dashboard Community Edition: 20.appendix/release-notes/dashboard-comm-release-note.md - Nebula Dashboard Enterprise Edition: 20.appendix/release-notes/dashboard-ent-release-note.md - Nebula Explorer: 20.appendix/release-notes/explorer-release-note.md - Learning path: 20.appendix/learning-path.md -#ent - About Nebula Graph licenses: 20.appendix/8.about-license.md + - About Nebula Graph licenses: 20.appendix/8.about-license.md - FAQ: 20.appendix/0.FAQ.md - Ecosystem tools: 20.appendix/6.eco-tool-version.md - Write tools: 20.appendix/write-tools.md