fix version

vesoft-inc · Apr 26, 2022 · 6d6b1b2 · 6d6b1b2
1 parent 2d1d34a
commit 6d6b1b2
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 65 deletions.
diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md
@@ -40,127 +40,127 @@ Nebula Graph Studio（简称 Studio）是一款可以通过 Web 访问的图数
 
 |Nebula Graph 版本|Studio 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{studio.release}}|
+| {{ nebula.tag }}  | {{studio.tag}}|
 
 ## Nebula Dashboard（社区版）
 
 Nebula Dashboard（简称 Dashboard）是一款用于监控 Nebula Graph 集群中机器和服务状态的可视化工具。详情参见[什么是 Nebula Dashboard](../nebula-dashboard/1.what-is-dashboard.md)。
 
 |Nebula Graph 版本|Dashboard 社区版本|
 |:---|:---|
-| {{ nebula.release }}  | {{dashboard.release}}|
+| {{ nebula.tag }}  | {{dashboard.tag}}|
 
 ## Nebula Dashboard（企业版）
 
 Nebula Dashboard（简称 Dashboard）是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具，支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是 Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。
 
 |Nebula Graph 版本|Dashboard 企业版本|
 |:---|:---|
-| {{ nebula.release }}  | {{dashboard_ent.release}}|
+| {{ nebula.tag }}  | {{dashboard_ent.tag}}|
 
 ## Nebula Explorer
 
 Nebula Explorer（简称 Explorer）是一款可以通过 Web 访问的图探索可视化工具，搭配 Nebula Graph 内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。详情参见[什么是 Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。
 
 |Nebula Graph 版本|Explorer 企业版本|
 |:---|:---|
-| {{ nebula.release }}  | {{explorer.release}}|
+| {{ nebula.tag }}  | {{explorer.tag}}|
 
 ## Nebula Stats Exporter
 
 [nebula-stats-exporter](https://github.com/vesoft-inc/nebula-stats-exporter)将监控数据导入Prometheus。
 
 |Nebula Graph 版本|Stats Exporter 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{exporter.release}}|
+| {{ nebula.tag }}  | {{exporter.tag}}|
 
 ## Nebula Exchange
 
 Nebula Exchange（简称 Exchange）是一款 Apache Spark&trade; 应用，用于在分布式环境中将集群中的数据批量迁移到 Nebula Graph 中，能支持多种不同格式的批式数据和流式数据的迁移。详情请参见[什么是 Nebula Exchange](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md)。
 
 |Nebula Graph 版本|Exchange 版本| Exchange 企业版本|
 |:---|:---|:---|
-| {{ nebula.release }}  | {{exchange.release}} | {{exchange_ent.release}} |
+| {{ nebula.tag }}  | {{exchange.tag}} | {{exchange_ent.tag}} |
 
 ## Nebula Operator
 
 Nebula Operator（简称 Operator）是用于在 Kubernetes 系统上自动化部署和运维 Nebula Graph 集群的工具。依托于 Kubernetes 扩展机制，Nebula Graph 将其运维领域的知识全面注入至 Kubernetes 系统中，让 Nebula Graph 成为真正的云原生图数据库。详情请参考[什么是 Nebula Operator](../nebula-operator/1.introduction-to-nebula-operator.md)。
 
 |Nebula Graph 版本|Operator 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{operator.release}}|
+| {{ nebula.tag }}  | {{operator.tag}}|
 
 ## Nebula Importer
 
 Nebula Importer（简称 Importer）是一款 Nebula Graph 的 CSV 文件导入工具。Importer 可以读取本地的 CSV 文件，然后导入数据至 Nebula Graph 图数据库中。详情请参见[什么是 Nebula Importer](../nebula-importer/use-importer.md)。
 
 |Nebula Graph 版本|Importer 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{importer.release}}|
+| {{ nebula.tag }}  | {{importer.tag}}|
 
 ## Nebula Spark Connector
 
 Nebula Spark Connector 是一个 Spark 连接器，提供通过 Spark 标准形式读写 Nebula Graph 数据的能力。Nebula Spark Connector 由 Reader 和 Writer 两部分组成。详情请参见[什么是 Nebula Spark Connector](../nebula-spark-connector.md)。
 
 |Nebula Graph 版本|Spark Connector 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{sparkconnector.release}}|
+| {{ nebula.tag }}  | {{sparkconnector.tag}}|
 
 ## Nebula Flink Connector
 
 Nebula Flink Connector 是一款帮助 Flink 用户快速访问 Nebula Graph 的连接器，支持从 Nebula Graph 图数据库中读取数据，或者将其他外部数据源读取的数据写入 Nebula Graph 图数据库。详情请参见[什么是 Nebula Flink Connector](../nebula-flink-connector.md)。
 
 |Nebula Graph 版本|Flink Connector 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{flinkconnector.release}}|
+| {{ nebula.tag }}  | {{flinkconnector.tag}}|
 
 ## Nebula Algorithm
 
 Nebula Algorithm（简称 Algorithm）是一款基于 [GraphX](https://spark.apache.org/graphx/) 的 Spark 应用程序，通过提交 Spark 任务的形式使用完整的算法工具对 Nebula Graph 数据库中的数据执行图计算，也可以通过编程形式调用 lib 库下的算法针对 DataFrame 执行图计算。详情请参见[什么是 Nebula Algorithm](../nebula-algorithm.md)。
 
 |Nebula Graph 版本|Algorithm 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{algorithm.release}}|
+| {{ nebula.tag }}  | {{algorithm.tag}}|
 
 ## Nebula Analytics
 
 Nebula Analytics是一款集成了开源高性能图计算框架 Plato 的应用程序，支持利用 Plato 对 Nebula Graph 数据库中的数据执行图计算。详情请参见[什么是 Nebula Analytics](../nebula-analytics.md)。
 
 |Nebula Graph 版本|Analytics 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{plato.release}}|
+| {{ nebula.tag }}  | {{plato.tag}}|
 
 ## Nebula Console
 
 Nebula Console 是 Nebula Graph 的原生 CLI 客户端。如何使用请参见 [Nebula Console](../nebula-console.md)。
 
 |Nebula Graph 版本|Console 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{console.release}}|
+| {{ nebula.tag }}  | {{console.tag}}|
 
 ## Nebula Docker Compose
 
 Docker Compose 可以快速部署 Nebula Graph 集群。如何使用请参见 [Docker Compose 部署 Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)。
 
 |Nebula Graph 版本|Docker Compose 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{dockercompose.release}}|
+| {{ nebula.tag }}  | {{dockercompose.tag}}|
 
 ## Backup & Restore
 
-[Backup&Restore](https://github.com/vesoft-inc/nebula-br)（简称 BR）是一款命令行界面（CLI）工具，可以帮助备份 Nebula Graph 的图空间数据，或者通过备份文件恢复数据。
+[Backup&Restore](https://github.com/vesoft-inc/nebula-br/tags/{{br.tag}})（简称 BR）是一款命令行界面（CLI）工具，可以帮助备份 Nebula Graph 的图空间数据，或者通过备份文件恢复数据。
 
 |Nebula Graph 版本|BR 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{br.release}}|
+| {{ nebula.tag }}  | {{br.tag}}|
 
 ## Nebula Bench
 
-[Nebula Bench](https://github.com/vesoft-inc/nebula-bench) 用于测试 Nebula Graph 的基线性能数据，使用 LDBC v0.3.3 的标准数据集。
+[Nebula Bench](https://github.com/vesoft-inc/nebula-bench/releases/tag/{{bench.tag}}) 用于测试 Nebula Graph 的基线性能数据，使用 LDBC v0.3.3 的标准数据集。
 
 |Nebula Graph 版本|Bench 版本|
 |:---|:---|
-| {{ nebula.release }}  | {{bench.release}}|
+| {{ nebula.tag }}  | {{bench.tag}}|
 
 ## API、SDK
 
@@ -170,22 +170,15 @@ Docker Compose 可以快速部署 Nebula Graph 集群。如何使用请参见 [D
 
 |Nebula Graph 版本| 语言（commit id） |
 |:---| :--- |
-| {{ nebula.release }}| [C++](https://github.com/vesoft-inc/nebula-cpp/tree/{{cpp.branch}})|
-| {{ nebula.release }}| [Go](https://github.com/vesoft-inc/nebula-go/tree/{{go.branch}})|
-| {{ nebula.release }}| [Python](https://github.com/vesoft-inc/nebula-python/tree/{{python.branch}}) |
-| {{ nebula.release }}| [Java](https://github.com/vesoft-inc/nebula-java/tree/{{java.branch}}) |
-| {{ nebula.release }} | [HTTP](https://github.com/vesoft-inc/nebula-http-gateway) |
+| {{ nebula.tag }}| [C++](https://github.com/vesoft-inc/nebula-cpp/releases/tag/{{cpp.tag}} |
+| {{ nebula.tag }}| [Go](https://github.com/vesoft-inc/nebula-go/releases/tag/{{go.tag}}) |
+| {{ nebula.tag }}| [Python](https://github.com/vesoft-inc/nebula-python/releases/tag/{{python.tagh}}) |
+| {{ nebula.tag }}| [Java](https://github.com/vesoft-inc/nebula-java/releases/tag/{{java.tag}})  |
+| {{ nebula.tag }}| [HTTP](https://github.com/vesoft-inc/nebula-http-gateway/releases/tag/{{gateway.tag}})  |
 
 ## 未发布
 
-- API
-
-  - [Rust Client](https://github.com/vesoft-inc/nebula-rust)
-
-  - [Node.js Client](https://github.com/vesoft-inc/nebula-node)
-
-  - [Object Graph Mapping Library (OGM, or ORM)] Java, Python (TODO: in design) 
-
-- 测试
-
-  - [Chaos Test](https://github.com/vesoft-inc/nebula-chaos)
+ - [Rust Client](https://github.com/vesoft-inc/nebula-rust)
+ - [Node.js Client](https://github.com/vesoft-inc/nebula-node)
+ - Object Graph Mapping Library (OGM, or ORM)
+ - 测试
diff --git a/docs-2.0/20.appendix/history.md b/docs-2.0/20.appendix/history.md
@@ -31,12 +31,8 @@
 
 7. 2021.8 发布 v2.5.0
 
-  ![image](https://docs-cdn.nebula-graph.com.cn/books/images/2.5.0.png)
-
 8. 2021.10 发布 v2.6.0
 
-  更多信息，参见[Releases](https://github.com/vesoft-inc/nebula/releases)。
-
 9. 2022.2 发布 v3.0.0
 
-  更多信息，参见[Releases](https://github.com/vesoft-inc/nebula/releases)。
+10. 2022.4 发布 v3.1.0
diff --git a/...2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md b/...2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
@@ -70,7 +70,7 @@
    1. 使用 Nebula Console 镜像启动一个容器，并连接到 Nebula Graph 服务所在的网络（nebula-docker-compose_nebula-net）中。
 
       ```bash
-      $ docker run --rm -ti --network nebula-docker-compose_nebula-net --entrypoint=/bin/sh vesoft/nebula-console:{{console.branch}}
+      $ docker run --rm -ti --network nebula-docker-compose_nebula-net --entrypoint=/bin/sh vesoft/nebula-console:{{console.tag}}
       ```
 
     !!! Note
@@ -256,7 +256,7 @@ graphd:
 执行如下命令可以更新 Nebula Console 客户端镜像。
 
 ```bash
-docker pull vesoft/nebula-console:{{console.branch}}
+docker pull vesoft/nebula-console:{{console.tag}}
 ```
 
 ### 为什么更新 nebula-docker-compose 仓库（Nebula Graph 2.0.0-RC）后，无法通过端口`3699`连接 Nebula Graph？

diff --git a/docs-2.0/nebula-bench.md b/docs-2.0/nebula-bench.md
@@ -12,14 +12,4 @@ Nebula Bench 是一款利用 LDBC 数据集对 Nebula Graph 进行性能测试
 
 [Release](https://github.com/vesoft-inc/nebula-bench/releases/tag/{{bench.tag}})
 
-<!--
-## 测试流程
-
-1. 使用 ldbc_snb_datagen 生成测试数据。
-
-2. 使用 importer 导入数据到 Nebula Graph。
-
-3. 使用 K6（含 xk6-nebula 插件）进行性能测试。
--->
-
 详细使用说明请参见 [Nebula Bench](https://github.com/vesoft-inc/nebula-bench/blob/{{bench.branch}}/README_cn.md)。
diff --git a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md
@@ -46,4 +46,4 @@ Nebula Graph 的版本和 Dashboard 社区版的版本对应关系如下。
 
 ## 更新说明
 
-[Release](https://github.com/vesoft-inc/nebula-dashboard/releases/tag/{{dashboard.branch}})
+[Release](https://github.com/vesoft-inc/nebula-dashboard/releases/tag/{{dashboard.tag}})
diff --git a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md
@@ -28,11 +28,11 @@
 
 | Dashboard 安装包 | Nebula Graph 版本 |
 | :----- | :----- |
-| [nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | 2.5.x ~ 3.1.x |
+| [nebula-dashboard-{{ dashboard.tag }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.tag }}/nebula-dashboard-{{ dashboard.tag }}.x86_64.tar.gz) | 2.5.x ~ 3.1.x |
 
 ## 目录结构说明
 
-执行命令`tar -xvf nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz`解压缩，目录`nebula-dashboard/vendors`内一共有 4 个子目录，说明如下。
+执行命令`tar -xvf nebula-dashboard-{{ dashboard.tag }}.x86_64.tar.gz`解压缩，目录`nebula-dashboard/vendors`内一共有 4 个子目录，说明如下。
 
 |目录名称|说明|端口号|
 |:---|:---|:---|

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
@@ -48,4 +48,4 @@ Nebula Operator 的扩缩容功能仅对企业版的 Nebula Graph 集群开放
 
 ## 更新说明
 
-[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/{{operator.branch}})
+[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/{{operator.tag}})
diff --git a/docs-2.0/nebula-operator/4.connect-to-nebula-graph-service.md b/docs-2.0/nebula-operator/4.connect-to-nebula-graph-service.md
@@ -25,13 +25,13 @@
 2. 使用上述`<cluster-name>-graphd-svc` Service 的 IP 连接 Nebula Graph 数据库：
 
   ```bash
-  kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- <nebula_console_name> -addr <cluster_ip>  -port <service_port> -u <username> -p <password>
+  kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- <nebula_console_name> -addr <cluster_ip>  -port <service_port> -u <username> -p <password>
   ```
 
   示例：
 
   ```bash
-  kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- nebula-console -addr 10.98.213.34  -port 9669 -u root -p vesoft
+  kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- nebula-console -addr 10.98.213.34  -port 9669 -u root -p vesoft
   ```
 
   - `--image`：为连接 Nebula Graph 的工具 Nebula Console 的镜像。
@@ -52,7 +52,7 @@
 用户还可以使用**完全限定域名（FQDN）**连接数据库，域名格式为`<cluster-name>-graphd.<cluster-namespace>.svc.<CLUSTER_DOMAIN>`：
 
 ```bash
-kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- <nebula_console_name> -addr <cluster_name>-graphd-svc.default.svc.cluster.local -port <service_port> -u <username> -p <password>
+kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- <nebula_console_name> -addr <cluster_name>-graphd-svc.default.svc.cluster.local -port <service_port> -u <username> -p <password>
 ```
 `CLUSTER_DOMAIN`的默认值为`cluster.local`。
 
@@ -126,13 +126,13 @@ kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never
 4. 使用节点 IP 和上述映射的节点端口连接 Nebula Graph。
   
   ```bash
-  kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- <nebula_console_name> -addr <node_ip> -port <node_port> -u <username> -p <password>
+  kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- <nebula_console_name> -addr <node_ip> -port <node_port> -u <username> -p <password>
   ```
 
   示例如下：
 
   ```bash
-  kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- nebula-console2 -addr 192.168.8.24 -port 32236 -u root -p vesoft
+  kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- nebula-console2 -addr 192.168.8.24 -port 32236 -u root -p vesoft
   If you don't see a command prompt, try pressing enter.
 
   (root@nebula) [(none)]>
@@ -212,13 +212,13 @@ data:
 4. 执行以下命令部署连接 Nebula Graph 服务的 Console 并通过宿主机 IP（本示例为`192.168.8.160`）和上述配置的外部端口访问 Nebula Graph 服务。
 
   ```bash
-  kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- <nebula_console_name> -addr <host_ip> -port <external_port> -u <username> -p <password>
+  kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- <nebula_console_name> -addr <host_ip> -port <external_port> -u <username> -p <password>
   ```
 
   示例：
 
   ```bash
-  kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- nebula-console -addr 192.168.8.160 -port 9769 -u root -p vesoft
+  kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- nebula-console -addr 192.168.8.160 -port 9769 -u root -p vesoft
   ```
 
   - `--image`：为连接 Nebula Graph 的工具 Nebula Console 的镜像。

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -50,22 +50,24 @@ extra:
       link: 'https://github.com/vesoft-inc/nebula-docs-cn'
   nebula:
     release: 3.1.0
-    tag: v3.1.0
-    branch: release-3.1
     nightly: nightly
     master: master
     base20: 2.0
     base200: 2.0.0
+    branch: release-3.1
   studio:
     base111b: 1.1.1-beta
     base220: 2.2.1
     base300: 3.0.0
     release: 3.3.0
   explorer:
     release: 3.0.0
+    branch: reelase-3.0
+    tag: v3.0.0
   exchange_ent:
     release: 3.0.0
     branch: v3.0.0
+    tag: v3.0.0
   exchange:
     release: 3.0.0
     branch: v3.0.0
@@ -77,9 +79,11 @@ extra:
   algorithm:
     release: 3.0.0
     branch: v3.0.0
+    tag: v3.0.0
   plato:
     release: 3.1.0
     branch: release-3.1
+    tag: v3.1.0
   sparkconnector:
     release: 3.0.0
     branch: v3.0.0
@@ -91,17 +95,24 @@ extra:
   dockercompose:
     release: 3.1.0
     branch: release-3.1
+    tag: v3.1.0
   dashboard:
     release: 3.0.0
+    tag: v1.1.0
     base100: 1.0.0
-    branch: release-3.0
+    branch: v1.1.0
   dashboard_ent:
     release: 3.0.0
+    tag: v3.0.0
+    branch: release-3.0
   console:
     release: 3.0.0
     branch: v3.0.0
+    tag: v3.0.0
   br:
     release: 0.6.0
+    branch: master
+    tag: v0.6.0
   cpp:
     release: 3.0.0
     branch: v3.0.0
@@ -127,6 +138,9 @@ extra:
   exporter:
     release: 3.1.0
     branch: release-3.1
+    tag: v3.1.0
+
+
 nav:
   - 前言: README.md
   - 简介:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -46,4 +46,4 @@ Nebula Graph 的版本和 Dashboard 社区版的版本对应关系如下。

		## 更新说明

		[Release](https://github.com/vesoft-inc/nebula-dashboard/releases/tag/{{dashboard.branch}})
		[Release](https://github.com/vesoft-inc/nebula-dashboard/releases/tag/{{dashboard.tag}})
Original file line number	Diff line number	Diff line change
Expand Up		@@ -48,4 +48,4 @@ Nebula Operator 的扩缩容功能仅对企业版的 Nebula Graph 集群开放

		## 更新说明

		[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/{{operator.branch}})
		[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/{{operator.tag}})