You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by ji...@apache.org on 2023/12/21 15:52:39 UTC
(incubator-hugegraph-doc) branch master updated: chore(website): fix link path (#309)
This is an automated email from the ASF dual-hosted git repository.
jin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
The following commit(s) were added to refs/heads/master by this push:
new 4f07fcd5 chore(website): fix link path (#309)
4f07fcd5 is described below
commit 4f07fcd5836830904ae72a50a342fb8726866f65
Author: SunnyBoy-WYH <48...@users.noreply.github.com>
AuthorDate: Thu Dec 21 23:52:35 2023 +0800
chore(website): fix link path (#309)
* Apply suggestions from code review
---------
Co-authored-by: imbajin <ji...@apache.org>
---
.../cn/docs/contribution-guidelines/contribute.md | 8 +--
.../contribution-guidelines/validate-release.md | 45 ++++++++++------
content/cn/docs/download/download.md | 24 +++++----
.../621swaggerui-set-auth-example.png | Bin
.../621swaggerui-where-set-auth-example.png | Bin
content/cn/docs/quickstart/hugegraph-server.md | 10 ++--
.../en/docs/contribution-guidelines/contribute.md | 8 +--
.../contribution-guidelines/validate-release.md | 57 ++++++++++++++-------
content/en/docs/download/download.md | 24 +++++----
content/en/docs/quickstart/hugegraph-server.md | 8 +--
10 files changed, 110 insertions(+), 74 deletions(-)
diff --git a/content/cn/docs/contribution-guidelines/contribute.md b/content/cn/docs/contribution-guidelines/contribute.md
index 7bb047fc..05b6a598 100644
--- a/content/cn/docs/contribution-guidelines/contribute.md
+++ b/content/cn/docs/contribution-guidelines/contribute.md
@@ -79,10 +79,10 @@ Note: In order to be consistent with the code style easily, if you use [IDEA](ht
##### 3.2.1 添加第三方依赖
如果我们要在 `HugeGraph` 项目中添加新的第三方依赖, 我们需要做下面的几件事情：
-1. 找到第三方依赖的仓库，将依赖的 `license` 文件放到 [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses) 路径下。
-2. 在[./hugegraph-dist/release-docs/LICENSE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/LICENSE) 中声明该依赖的 `LICENSE` 信息。
-3. 找到仓库里的 NOTICE 文件，将其追加到 [./hugegraph-dist/release-docs/NOTICE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/NOTICE) 文件后面（如果没有NOTICE文件则跳过这一步）。
-4. 本地执行[./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) 脚本来更新依赖列表[known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/known-dependencies.txt) (或者手动更新)。
+1. 找到第三方依赖的仓库，将依赖的 `license` 文件放到 [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-server/hugegraph-dist/release-docs/licenses) 路径下。
+2. 在[./hugegraph-dist/release-docs/LICENSE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/release-docs/LICENSE) 中声明该依赖的 `LICENSE` 信息。
+3. 找到仓库里的 NOTICE 文件，将其追加到 [./hugegraph-dist/release-docs/NOTICE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/release-docs/NOTICE) 文件后面（如果没有NOTICE文件则跳过这一步）。
+4. 本地执行[./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) 脚本来更新依赖列表[known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/known-dependencies.txt) (或者手动更新)。
**例如**：在项目中引入了第三方新依赖 -> `ant-1.9.1.jar`
- 项目源码位于：https://github.com/apache/ant/tree/rel/1.9.1
diff --git a/content/cn/docs/contribution-guidelines/validate-release.md b/content/cn/docs/contribution-guidelines/validate-release.md
index ef51792f..cae42194 100644
--- a/content/cn/docs/contribution-guidelines/validate-release.md
+++ b/content/cn/docs/contribution-guidelines/validate-release.md
@@ -37,10 +37,10 @@ sudo apt-get install wget -y
# MacOS
brew install wget
-# 4. 下载 hugegraph-svn 目录 (版本号注意填写此次验证版本, 这里以1.0.0为例)
-svn co https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/
+# 4. 下载 hugegraph-svn 目录 (版本号注意填写此次验证版本)
+svn co https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.x.x/
# (注) 如果出现 svn 下载某个文件速度很慢的情况, 可以考虑 wget 单个文件下载, 如下 (或考虑使用 VPN / 代理)
-wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
+wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.x.x/apache-hugegraph-toolchain-incubating-1.x.x.tar.gz
```
#### 2. 检查 hash 值
@@ -137,9 +137,6 @@ bin/hugegraph-loader.sh -f path -g graph -s schema
# hugegraph-hubble
bin/start-hubble.sh
-# hugegraph-computer
-bin/start-computer.sh -d local -r master
-
更多参考官网: https://hugegraph.apache.org/cn/docs/quickstart
```
@@ -154,15 +151,26 @@ bin/start-computer.sh -d local -r master
## 邮件模板
检查完成后, 你应该按不同角色回复邮件: (普通开发者 & PMC 成员)
+```markdown
+[] +1 approve
+[] +0 no opinion
+
+[] -1 disapprove with the reason
+```
```markdown
+1 (non-binding)
I checked:
-1. All download links are valid
-2. Checksum and signature are OK
-3. LICENSE and NOTICE are exist
-4. Build successfully on macOS(Big Sur)
-5. ....
+1.Download link/tag in mail are valid
+2.Checksum and GPG signatures are OK
+3.LICENSE & NOTICE & DISCLAIMER are exist
+4.Build successfully on XX OS version XXX
+5.No unexpected binary files
+6.Date is right in the NOTICE file
+7.Compile from source is fine under JavaX
+8.No empty file & directory found
+9. Test running xxx service OK
+10. ....
```
特别注意 PMC 成员必须使用 `binding` 标记回复邮件, 这对于统计有效投票很重要;
@@ -170,10 +178,15 @@ I checked:
```markdown
+1 (binding)
I checked:
-1. All download links are valid
-2. Checksum and signature are OK
-3. LICENSE and NOTICE are exist
-4. Build successfully on macOS(Big Sur)
-5. ....
+1.Download link/tag in mail are valid
+2.Checksum and GPG signatures are OK
+3.LICENSE & NOTICE & DISCLAIMER are exist
+4.Build successfully on XX OS Version XX
+5.No unexpected binary files
+6.Date is right in the NOTICE file
+7.Compile from source is fine under JavaXX
+8.No empty file & directory found
+9. Test running XXX service OK
+10. ....
```
diff --git a/content/cn/docs/download/download.md b/content/cn/docs/download/download.md
index d46c0887..cfb8a919 100644
--- a/content/cn/docs/download/download.md
+++ b/content/cn/docs/download/download.md
@@ -29,17 +29,19 @@ The latest HugeGraph: **1.0.0**, released on _2023-02-22_([how to build from sou
### 旧版本下载地址 (Outdated Versions Mapping)
-| server | client | loader | hubble | common [...]
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- [...]
-| [0.12.0](https://github.com/hugegraph/hugegraph/releases/download/v0.12.0/hugegraph-0.12.0.tar.gz) | [2.0.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/2.0.1) | [0.12.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.12.0/hugegraph-loader-0.12.0.tar.gz) | [1.6.0](https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.6.0/hugegraph-hubble-1.6.0.tar.gz) | [2.0.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.11.2](https://github.com/hugegraph/hugegraph/releases/download/v0.11.2/hugegraph-0.11.2.tar.gz) | [1.9.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.9.1) | [0.11.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.11.1/hugegraph-loader-0.11.1.tar.gz) | [1.5.0](https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.5.0/hugegraph-hubble-1.5.0.tar.gz) | [1.8.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.10.4](https://github.com/hugegraph/hugegraph/releases/download/v0.10.4/hugegraph-0.10.4.tar.gz) | [1.8.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.8.0) | [0.10.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.10.1/hugegraph-loader-0.10.1.tar.gz) | [0.10.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.10.0/hugegraph-studio-0.10.0.tar.gz) | [1.6.16](https://mvnrepository.com/artifact/com.baidu.hugegraph/huge [...]
-| [0.9.2](https://github.com/hugegraph/hugegraph/releases/download/v0.9.2/hugegraph-0.9.2.tar.gz) | [1.7.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.7.0) | [0.9.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.9.0/hugegraph-loader-0.9.0.tar.gz) | [0.9.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.9.0/hugegraph-studio-0.9.0.tar.gz) | [1.6.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.8.0](https://github.com/hugegraph/hugegraph/releases/download/v0.8.0/hugegraph-0.8.0.tar.gz) | [1.6.4](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.6.4) | [0.8.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.8.0/hugegraph-loader-0.8.0.tar.gz) | [0.8.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.8.0/hugegraph-studio-0.8.0.tar.gz) | [1.5.3](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.7.4](https://github.com/hugegraph/hugegraph/releases/download/v0.7.4/hugegraph-0.7.4.tar.gz) | [1.5.8](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.8) | [0.7.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.7.0/hugegraph-loader-0.7.0.tar.gz) | [0.7.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.7.0/hugegraph-studio-0.7.0.tar.gz) | [1.4.9](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.6.1](https://github.com/hugegraph/hugegraph/releases/download/v0.6.1/hugegraph-0.6.1.tar.gz) | [1.5.6](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.6) | [0.6.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.6.1/hugegraph-loader-0.6.1.tar.gz) | [0.6.1](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.6.1/hugegraph-studio-0.6.1.tar.gz) | [1.4.3](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.5.6-SNAPSHOT.tar.gz) | [1.5.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.0) | [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.5.6-bin.tar.gz) | [0.5.0](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.5.0-SNAPSHOT.tar.gz) | 1.4.0 [...]
-| [0.4.5](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.4.5-SNAPSHOT.tar.gz) | [1.4.7](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.4.7) | [0.2.2](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.2.2-bin.tar.gz) | [0.4.1](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.4.1-SNAPSHOT.tar.gz) | 1.3.12 [...]
+对于 1.0.0 之前的版本（即非 ASF 版本），HugeGraph 社区将不再维护。
+
+| server | client | loader | hubble | common [...]
+|-----------------------------------------------------------------------------------------------------------| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- [...]
+| [0.12.0](https://github.com/apache/incubator-hugegraph/releases/download/v0.12.0/hugegraph-0.12.0.tar.gz) | [2.0.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/2.0.1) | [0.12.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.12.0/hugegraph-loader-0.12.0.tar.gz) | [1.6.0](https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.6.0/hugegraph-hubble-1.6.0.tar.gz) | [2.0.1](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.11.2](https://github.com/apache/incubator-hugegraph/releases/download/v0.11.2/hugegraph-0.11.2.tar.gz) | [1.9.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.9.1) | [0.11.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.11.1/hugegraph-loader-0.11.1.tar.gz) | [1.5.0](https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.5.0/hugegraph-hubble-1.5.0.tar.gz) | [1.8.1](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.10.4](https://github.com/apache/incubator-hugegraph/releases/download/v0.10.4/hugegraph-0.10.4.tar.gz) | [1.8.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.8.0) | [0.10.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.10.1/hugegraph-loader-0.10.1.tar.gz) | [0.10.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.10.0/hugegraph-studio-0.10.0.tar.gz) | [1.6.16](https://mvnrepository.com/artifact/com.baidu.hugegra [...]
+| [0.9.2](https://github.com/apache/incubator-hugegraph/releases/download/v0.9.2/hugegraph-0.9.2.tar.gz) | [1.7.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.7.0) | [0.9.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.9.0/hugegraph-loader-0.9.0.tar.gz) | [0.9.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.9.0/hugegraph-studio-0.9.0.tar.gz) | [1.6.0](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.8.0](https://github.com/apache/incubator-hugegraph/releases/download/v0.8.0/hugegraph-0.8.0.tar.gz) | [1.6.4](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.6.4) | [0.8.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.8.0/hugegraph-loader-0.8.0.tar.gz) | [0.8.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.8.0/hugegraph-studio-0.8.0.tar.gz) | [1.5.3](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.7.4](https://github.com/apache/incubator-hugegraph/releases/download/v0.7.4/hugegraph-0.7.4.tar.gz) | [1.5.8](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.8) | [0.7.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.7.0/hugegraph-loader-0.7.0.tar.gz) | [0.7.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.7.0/hugegraph-studio-0.7.0.tar.gz) | [1.4.9](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.6.1](https://github.com/apache/incubator-hugegraph/releases/download/v0.6.1/hugegraph-0.6.1.tar.gz) | [1.5.6](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.6) | [0.6.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.6.1/hugegraph-loader-0.6.1.tar.gz) | [0.6.1](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.6.1/hugegraph-studio-0.6.1.tar.gz) | [1.4.3](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.5.6-SNAPSHOT.tar.gz) | [1.5.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.0) | [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.5.6-bin.tar.gz) | [0.5.0](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.5.0-SNAPSHOT.tar.gz) | 1.4.0 [...]
+| [0.4.5](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.4.5-SNAPSHOT.tar.gz) | [1.4.7](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.4.7) | [0.2.2](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.2.2-bin.tar.gz) | [0.4.1](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.4.1-SNAPSHOT.tar.gz) | 1.3.12 [...]
> 说明：最新的图分析和展示平台为 hubble，支持 0.10 及之后的 server 版本；studio 为 server 0.10.x 以及之前的版本的图分析和展示平台，其功能从 0.10 起不再更新。
diff --git "a/content/cn/docs/images/images-server/621swaggerui\350\256\276\347\275\256\351\211\264\346\235\203\347\244\272\344\276\213.png" b/content/cn/docs/images/images-server/621swaggerui-set-auth-example.png
similarity index 100%
rename from "content/cn/docs/images/images-server/621swaggerui\350\256\276\347\275\256\351\211\264\346\235\203\347\244\272\344\276\213.png"
rename to content/cn/docs/images/images-server/621swaggerui-set-auth-example.png
diff --git "a/content/cn/docs/images/images-server/621swaggerui\350\256\276\347\275\256\351\211\264\346\235\203\344\275\215\347\275\256\347\244\272\344\276\213.jpg" b/content/cn/docs/images/images-server/621swaggerui-where-set-auth-example.png
similarity index 100%
rename from "content/cn/docs/images/images-server/621swaggerui\350\256\276\347\275\256\351\211\264\346\235\203\344\275\215\347\275\256\347\244\272\344\276\213.jpg"
rename to content/cn/docs/images/images-server/621swaggerui-where-set-auth-example.png
diff --git a/content/cn/docs/quickstart/hugegraph-server.md b/content/cn/docs/quickstart/hugegraph-server.md
index a6753a0f..a6b387d7 100644
--- a/content/cn/docs/quickstart/hugegraph-server.md
+++ b/content/cn/docs/quickstart/hugegraph-server.md
@@ -89,7 +89,7 @@ mvn package -DskipTests
#### 3.3 使用 Docker 容器 (便于**测试**)
<!-- 3.1 is linked by other place. if change 3.1's title, please check -->
-可参考 [Docker 部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/README.md)。
+可参考 [Docker 部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/README.md)。
我们可以使用 `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`.
@@ -442,7 +442,7 @@ Connecting to HugeGraphServer (http://127.0.0.1:8080/graphs)......OK
在使用 Docker 的时候，我们可以使用 Cassandra 作为后端存储。我们更加推荐直接使用 docker-compose 来对于 server 以及 Cassandra 进行统一管理
-样例的 `docker-compose.yml` 可以在 [github](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/docker/example/docker-compose-cassandra.yml) 中获取，使用 `docker-compose up -d` 启动。(如果使用 cassandra 4.0 版本作为后端存储，则需要大约两个分钟初始化，请耐心等待)
+样例的 `docker-compose.yml` 可以在 [github](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/docker/example/docker-compose-cassandra.yml) 中获取，使用 `docker-compose up -d` 启动。(如果使用 cassandra 4.0 版本作为后端存储，则需要大约两个分钟初始化，请耐心等待)
```yaml
version: "3"
@@ -509,7 +509,7 @@ volumes:
2. 使用`docker-compose`
- 创建`docker-compose.yml`，具体文件如下，在环境变量中设置 PRELOAD=true。其中，[`example.groovy`](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/src/assembly/static/scripts/example.groovy) 是一个预定义的脚本，用于预加载样例数据。如果有需要，可以通过挂载新的 `example.groovy` 脚本改变预加载的数据。
+ 创建`docker-compose.yml`，具体文件如下，在环境变量中设置 PRELOAD=true。其中，[`example.groovy`](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy) 是一个预定义的脚本，用于预加载样例数据。如果有需要，可以通过挂载新的 `example.groovy` 脚本改变预加载的数据。
```yaml
version: '3'
@@ -656,13 +656,13 @@ _说明_
在使用 Swagger UI 调试 HugeGraph 提供的 API 时，如果 HugeGraph Server 开启了鉴权模式，可以在 Swagger 页面输入鉴权信息。
<div style="text-align: center;">
- <img src="/docs/images/images-server/621swaggerui设置鉴权位置示例.png" alt="image">
+ <img src="/docs/images/images-server/621swaggerui-where-set-auth-example.png" alt="image">
</div>
当前 HugeGraph 支持基于 Basic 和 Bearer 两种形式设置鉴权信息。
<div style="text-align: center;">
- <img src="/docs/images/images-server/621swaggerui设置鉴权示例.png" alt="image">
+ <img src="/docs/images/images-server/621swaggerui-set-auth-example.png" alt="image">
</div>
### 7 停止 Server
diff --git a/content/en/docs/contribution-guidelines/contribute.md b/content/en/docs/contribution-guidelines/contribute.md
index ac996143..e8741b1f 100644
--- a/content/en/docs/contribution-guidelines/contribute.md
+++ b/content/en/docs/contribution-guidelines/contribute.md
@@ -76,10 +76,10 @@ Note: In order to be consistent with the code style easily, if you use [IDEA](ht
##### 3.2.1 Check licenses
If we want to add new third-party dependencies to the `HugeGraph` project, we need to do the following things:
-1. Find the third-party dependent repository, put the dependent `license` file into [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses) path.
-2. Declare the dependency in [./hugegraph-dist/release-docs/LICENSE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/LICENSE) `LICENSE` information.
-3. Find the NOTICE file in the repository and append it to [./hugegraph-dist/release-docs/NOTICE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/NOTICE) file (skip this step if there is no NOTICE file).
-4. Execute locally [./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) to update the dependency list [known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/known-dependencies.txt) (or manually update) .
+1. Find the third-party dependent repository, put the dependent `license` file into [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-server/hugegraph-dist/release-docs/licenses) path.
+2. Declare the dependency in [./hugegraph-dist/release-docs/LICENSE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/release-docs/LICENSE) `LICENSE` information.
+3. Find the NOTICE file in the repository and append it to [./hugegraph-dist/release-docs/NOTICE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/release-docs/NOTICE) file (skip this step if there is no NOTICE file).
+4. Execute locally [./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) to update the dependency list [known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/known-dependencies.txt) (or manually update) .
**Example**: A new third-party dependency is introduced into the project -> `ant-1.9.1.jar`
- The project source code is located at: https://github.com/apache/ant/tree/rel/1.9.1
diff --git a/content/en/docs/contribution-guidelines/validate-release.md b/content/en/docs/contribution-guidelines/validate-release.md
index ddf5fd3d..d20bfa38 100644
--- a/content/en/docs/contribution-guidelines/validate-release.md
+++ b/content/en/docs/contribution-guidelines/validate-release.md
@@ -36,10 +36,12 @@ sudo apt-get install wget -y
# MacOS
brew install wget
-# 4. Download the hugegraph-svn directory (version number, pay attention to fill in the verification version, here we take 1.0.0 as an example)
-svn co https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/
-# (Note) If svn downloads a file very slowly, you can consider wget to download a single file, as follows (or consider using a proxy)
-wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
+# 4. Download the hugegraph-svn directory
+# For version number, pay attention to fill in the verification version
+svn co https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.x.x/
+# (Note) If svn downloads a file very slowly,
+# you can consider wget to download a single file, as follows (or consider using a proxy)
+wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.x.x/apache-hugegraph-toolchain-incubating-1.x.x.tar.gz
```
#### 2. check hash value
@@ -67,7 +69,8 @@ gpg: key 28DCAED849C4180E: public key "coderzc (CODE SIGNING KEY) <zhaocong@apac
gpg: Total number processed: 3
gpg: imported: 3
-# 2. Trust release users (trust n username mentioned in voting mail, if more than one user, just repeat the steps in turn or use the script below)
+# 2. Trust release users (trust n username mentioned in voting mail, if more than one user,
+# just repeat the steps in turn or use the script below)
gpg --edit-key $USER # input the username, enter the interactive mode
gpg> trust
...output options..
@@ -136,10 +139,7 @@ bin/hugegraph-loader.sh -f path -g graph -s schema
# hugegraph-hubble
bin/start-hubble.sh
-# hugegraph-computer
-bin/start-computer.sh -d local -r master
-
-more reference official website: https://hugegraph.apache.org/cn/docs/quickstart
+more reference official website: https://hugegraph.apache.org/docs/quickstart
```
**Note:** If a third-party dependency is introduced in the binary package, you need to update the LICENSE and add the third-party dependent LICENSE; if the third-party dependent LICENSE is Apache 2.0, and the corresponding project contains NOTICE, you also need to update Our NOTICE file
@@ -153,24 +153,43 @@ more reference official website: https://hugegraph.apache.org/cn/docs/quickstart
## Mail Template
After the check & test, you should reply the mail with the following content: (normal devs & PMC)
+
+```markdown
+[] +1 approve
+
+[] +0 no opinion
+
+[] -1 disapprove with the reason
+```
+
```markdown
+1 (non-binding)
I checked:
-1. All download links are valid
-2. Checksum and signature are OK
-3. LICENSE and NOTICE are exist
-4. Build successfully on macOS(Big Sur)
-5. ....
+1.Download link/tag in mail are valid
+2.Checksum and GPG signatures are OK
+3.LICENSE & NOTICE & DISCLAIMER are exist
+4.Build successfully on XX OS & Version XX
+5.No unexpected binary files
+6.Date is right in the NOTICE file
+7.Compile from source is fine under JavaXX
+8.No empty file & directory found
+9. Test running XXX service OK
+10. ....
```
and the PMC members should reply with `binding`, it's important for summary the valid votes:
```markdown
+1 (binding)
I checked:
-1. All download links are valid
-2. Checksum and signature are OK
-3. LICENSE and NOTICE are exist
-4. Build successfully on macOS(Big Sur)
-5. ....
+1.Download link/tag in mail are valid
+2.Checksum and GPG signatures are OK
+3.LICENSE & NOTICE & DISCLAIMER are exist
+4.Build successfully on XX OS & Version XX
+5.No unexpected binary files
+6.Date is right in the NOTICE file
+7.Compile from source is fine under JavaXX
+8.No empty file & directory found
+9. Test running XX process OK
+10. ....
```
diff --git a/content/en/docs/download/download.md b/content/en/docs/download/download.md
index ac296fcb..695ba15d 100644
--- a/content/en/docs/download/download.md
+++ b/content/en/docs/download/download.md
@@ -31,16 +31,18 @@ The latest HugeGraph: **1.0.0**, released on _2023-02-22_([how to build from sou
### Outdated Versions Mapping
-| server | client | loader | hubble | common [...]
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- [...]
-| [0.12.0](https://github.com/hugegraph/hugegraph/releases/download/v0.12.0/hugegraph-0.12.0.tar.gz) | [2.0.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/2.0.1) | [0.12.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.12.0/hugegraph-loader-0.12.0.tar.gz) | [1.6.0](https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.6.0/hugegraph-hubble-1.6.0.tar.gz) | [2.0.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.11.2](https://github.com/hugegraph/hugegraph/releases/download/v0.11.2/hugegraph-0.11.2.tar.gz) | [1.9.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.9.1) | [0.11.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.11.1/hugegraph-loader-0.11.1.tar.gz) | [1.5.0](https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.5.0/hugegraph-hubble-1.5.0.tar.gz) | [1.8.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.10.4](https://github.com/hugegraph/hugegraph/releases/download/v0.10.4/hugegraph-0.10.4.tar.gz) | [1.8.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.8.0) | [0.10.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.10.1/hugegraph-loader-0.10.1.tar.gz) | [0.10.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.10.0/hugegraph-studio-0.10.0.tar.gz) | [1.6.16](https://mvnrepository.com/artifact/com.baidu.hugegraph/huge [...]
-| [0.9.2](https://github.com/hugegraph/hugegraph/releases/download/v0.9.2/hugegraph-0.9.2.tar.gz) | [1.7.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.7.0) | [0.9.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.9.0/hugegraph-loader-0.9.0.tar.gz) | [0.9.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.9.0/hugegraph-studio-0.9.0.tar.gz) | [1.6.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.8.0](https://github.com/hugegraph/hugegraph/releases/download/v0.8.0/hugegraph-0.8.0.tar.gz) | [1.6.4](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.6.4) | [0.8.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.8.0/hugegraph-loader-0.8.0.tar.gz) | [0.8.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.8.0/hugegraph-studio-0.8.0.tar.gz) | [1.5.3](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.7.4](https://github.com/hugegraph/hugegraph/releases/download/v0.7.4/hugegraph-0.7.4.tar.gz) | [1.5.8](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.8) | [0.7.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.7.0/hugegraph-loader-0.7.0.tar.gz) | [0.7.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.7.0/hugegraph-studio-0.7.0.tar.gz) | [1.4.9](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.6.1](https://github.com/hugegraph/hugegraph/releases/download/v0.6.1/hugegraph-0.6.1.tar.gz) | [1.5.6](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.6) | [0.6.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.6.1/hugegraph-loader-0.6.1.tar.gz) | [0.6.1](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.6.1/hugegraph-studio-0.6.1.tar.gz) | [1.4.3](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugeg [...]
-| [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.5.6-SNAPSHOT.tar.gz) | [1.5.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.0) | [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.5.6-bin.tar.gz) | [0.5.0](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.5.0-SNAPSHOT.tar.gz) | 1.4.0 [...]
-| [0.4.5](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.4.5-SNAPSHOT.tar.gz) | [1.4.7](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.4.7) | [0.2.2](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.2.2-bin.tar.gz) | [0.4.1](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.4.1-SNAPSHOT.tar.gz) | 1.3.12 [...]
+For versions before 1.0.0 (i.e. non ASF versions), the HugeGraph community will no longer maintain them.
+
+| server | client | loader | hubble | common [...]
+|-----------------------------------------------------------------------------------------------------------| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- [...]
+| [0.12.0](https://github.com/apache/incubator-hugegraph/releases/download/v0.12.0/hugegraph-0.12.0.tar.gz) | [2.0.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/2.0.1) | [0.12.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.12.0/hugegraph-loader-0.12.0.tar.gz) | [1.6.0](https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.6.0/hugegraph-hubble-1.6.0.tar.gz) | [2.0.1](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.11.2](https://github.com/apache/incubator-hugegraph/releases/download/v0.11.2/hugegraph-0.11.2.tar.gz) | [1.9.1](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.9.1) | [0.11.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.11.1/hugegraph-loader-0.11.1.tar.gz) | [1.5.0](https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.5.0/hugegraph-hubble-1.5.0.tar.gz) | [1.8.1](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.10.4](https://github.com/apache/incubator-hugegraph/releases/download/v0.10.4/hugegraph-0.10.4.tar.gz) | [1.8.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.8.0) | [0.10.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.10.1/hugegraph-loader-0.10.1.tar.gz) | [0.10.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.10.0/hugegraph-studio-0.10.0.tar.gz) | [1.6.16](https://mvnrepository.com/artifact/com.baidu.hugegra [...]
+| [0.9.2](https://github.com/apache/incubator-hugegraph/releases/download/v0.9.2/hugegraph-0.9.2.tar.gz) | [1.7.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.7.0) | [0.9.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.9.0/hugegraph-loader-0.9.0.tar.gz) | [0.9.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.9.0/hugegraph-studio-0.9.0.tar.gz) | [1.6.0](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.8.0](https://github.com/apache/incubator-hugegraph/releases/download/v0.8.0/hugegraph-0.8.0.tar.gz) | [1.6.4](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.6.4) | [0.8.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.8.0/hugegraph-loader-0.8.0.tar.gz) | [0.8.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.8.0/hugegraph-studio-0.8.0.tar.gz) | [1.5.3](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.7.4](https://github.com/apache/incubator-hugegraph/releases/download/v0.7.4/hugegraph-0.7.4.tar.gz) | [1.5.8](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.8) | [0.7.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.7.0/hugegraph-loader-0.7.0.tar.gz) | [0.7.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.7.0/hugegraph-studio-0.7.0.tar.gz) | [1.4.9](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.6.1](https://github.com/apache/incubator-hugegraph/releases/download/v0.6.1/hugegraph-0.6.1.tar.gz) | [1.5.6](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.6) | [0.6.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.6.1/hugegraph-loader-0.6.1.tar.gz) | [0.6.1](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.6.1/hugegraph-studio-0.6.1.tar.gz) | [1.4.3](https://mvnrepository.com/artifact/com.baidu.hugegrap [...]
+| [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.5.6-SNAPSHOT.tar.gz) | [1.5.0](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.0) | [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.5.6-bin.tar.gz) | [0.5.0](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.5.0-SNAPSHOT.tar.gz) | 1.4.0 [...]
+| [0.4.5](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.4.5-SNAPSHOT.tar.gz) | [1.4.7](https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.4.7) | [0.2.2](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.2.2-bin.tar.gz) | [0.4.1](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.4.1-SNAPSHOT.tar.gz) | 1.3.12 [...]
> Note: The latest graph analysis and display platform is Hubble, which supports server v0.10 +.
diff --git a/content/en/docs/quickstart/hugegraph-server.md b/content/en/docs/quickstart/hugegraph-server.md
index 4e14d0dc..77cbd45a 100644
--- a/content/en/docs/quickstart/hugegraph-server.md
+++ b/content/en/docs/quickstart/hugegraph-server.md
@@ -454,7 +454,7 @@ In [3.3 Use Docker container](#33-use-docker-container), we have introduced how
When using Docker, we can use Cassandra as the backend storage. We highly recommend using docker-compose directly to manage both the server and Cassandra.
-The sample `docker-compose.yml` can be obtained on [github](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/docker/example/docker-compose-cassandra.yml), and you can start it with `docker-compose up -d`. (If using Cassandra 4.0 as the backend storage, it takes approximately two minutes to initialize. Please be patient.)
+The sample `docker-compose.yml` can be obtained on [github](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/docker/example/docker-compose-cassandra.yml), and you can start it with `docker-compose up -d`. (If using Cassandra 4.0 as the backend storage, it takes approximately two minutes to initialize. Please be patient.)
```yaml
version: "3"
@@ -521,7 +521,7 @@ Set the environment variable `PRELOAD=true` when starting Docker in order to loa
2. Use `docker-compose`
- Create `docker-compose.yml` as following. We should set the environment variable `PRELOAD=true`. [`example.groovy`](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/src/assembly/static/scripts/example.groovy) is a predefined script to preload the sample data. If needed, we can mount a new `example.groovy` to change the preload data.
+ Create `docker-compose.yml` as following. We should set the environment variable `PRELOAD=true`. [`example.groovy`](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy) is a predefined script to preload the sample data. If needed, we can mount a new `example.groovy` to change the preload data.
```yaml
version: '3'
@@ -666,13 +666,13 @@ You can also visit `localhost:8080/swagger-ui/index.html` to check the API.
When using Swagger UI to debug the API provided by HugeGraph, if HugeGraph Server turns on authentication mode, you can enter authentication information on the Swagger page.
<div style="text-align: center;">
- <img src="/docs/images/images-server/621swaggerui设置鉴权位置示例.png" alt="image">
+ <img src="/docs/images/images-server/621swaggerui-where-set-auth-example.png" alt="image">
</div>
Currently HugeGraph supports setting authentication information in two forms: Basic and Bearer.
<div style="text-align: center;">
- <img src="/docs/images/images-server/621swaggerui设置鉴权示例.png" alt="image">
+ <img src="/docs/images/images-server/621swaggerui-set-auth-example.png" alt="image">
</div>
### 7 Stop Server