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 c1a7c085 optimize doc (#199)
c1a7c085 is described below
commit c1a7c085f3a4b253537ea185af43394aca0a1c3e
Author: 青年 <[email protected]>
AuthorDate: Wed Feb 15 16:14:21 2023 +0800
optimize doc (#199)
Co-authored-by: imbajin <[email protected]>
---
content/cn/docs/contribution-guidelines/validate-release.md | 10 ++++++++--
content/cn/docs/quickstart/hugegraph-server.md | 2 ++
content/cn/docs/quickstart/hugegraph-tools.md | 1 +
content/en/docs/contribution-guidelines/validate-release.md | 10 ++++++++--
content/en/docs/quickstart/hugegraph-server.md | 1 +
content/en/docs/quickstart/hugegraph-tools.md | 1 +
6 files changed, 21 insertions(+), 4 deletions(-)
diff --git a/content/cn/docs/contribution-guidelines/validate-release.md
b/content/cn/docs/contribution-guidelines/validate-release.md
index 64a07b15..ef51792f 100644
--- a/content/cn/docs/contribution-guidelines/validate-release.md
+++ b/content/cn/docs/contribution-guidelines/validate-release.md
@@ -12,7 +12,7 @@ weight: 3
#### 1. 准备工作
-如果本地没有 svn 或 gpg 环境, 建议先安装一下 (windows 推荐使用 WSL2 环境, 或者至少是 `git-bash`)
+如果本地没有 svn 或 gpg 或 wget 环境, 建议先安装一下 (windows 推荐使用 WSL2 环境, 或者至少是 `git-bash`),
同时确保安装Java(推荐11)和maven软件。
```bash
# 1. 安装svn
@@ -31,7 +31,13 @@ brew install gnupg
# 验证安装是否成功, 执行以下命令:
gpg --version
-# 3. 下载 hugegraph-svn 目录 (版本号注意填写此次验证版本, 这里以1.0.0为例)
+# 3. 安装wget
+# ubuntu/debian
+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/
# (注) 如果出现 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
diff --git a/content/cn/docs/quickstart/hugegraph-server.md
b/content/cn/docs/quickstart/hugegraph-server.md
index 7317cc97..7e941d3c 100644
--- a/content/cn/docs/quickstart/hugegraph-server.md
+++ b/content/cn/docs/quickstart/hugegraph-server.md
@@ -73,6 +73,8 @@ tar zxf *hugegraph*.tar.gz
#### 3.3 源码编译
+源码编译前请确保安装了wget命令
+
下载HugeGraph源代码
```bash
diff --git a/content/cn/docs/quickstart/hugegraph-tools.md
b/content/cn/docs/quickstart/hugegraph-tools.md
index 4b0b3db7..598d3d80 100644
--- a/content/cn/docs/quickstart/hugegraph-tools.md
+++ b/content/cn/docs/quickstart/hugegraph-tools.md
@@ -25,6 +25,7 @@ tar zxf *hugegraph*.tar.gz
```
#### 2.2 下载源码编译安装
+源码编译前请确保安装了wget命令
下载最新版本的 HugeGraph-Toolchain 源码包, 然后根目录编译或者单独编译 tool 子模块：
diff --git a/content/en/docs/contribution-guidelines/validate-release.md
b/content/en/docs/contribution-guidelines/validate-release.md
index 4493601d..ddf5fd3d 100644
--- a/content/en/docs/contribution-guidelines/validate-release.md
+++ b/content/en/docs/contribution-guidelines/validate-release.md
@@ -12,7 +12,7 @@ When the internal temporary release and packaging work is
completed, other commu
#### 1. prepare
-If there is no svn or gpg environment locally, it is recommended to install it
first (windows recommend using WSL2 environment, or at least `git-bash`)
+If there is no svn or gpg or wget environment locally, it is recommended to
install it first (windows recommend using WSL2 environment, or at least
`git-bash`), also make sure to install java (recommended 11) and maven software
```bash
# 1. install svn
# ubuntu/debian
@@ -30,7 +30,13 @@ brew install gnupg
# To verify that the installation was successful, execute the following
command:
gpg --version
-# 3. Download the hugegraph-svn directory (version number, pay attention to
fill in the verification version, here we take 1.0.0 as an example)
+# 3. install wget (we will enhance it later, like use `curl`)
+# ubuntu/debian
+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
diff --git a/content/en/docs/quickstart/hugegraph-server.md
b/content/en/docs/quickstart/hugegraph-server.md
index aab76b09..36467b80 100644
--- a/content/en/docs/quickstart/hugegraph-server.md
+++ b/content/en/docs/quickstart/hugegraph-server.md
@@ -73,6 +73,7 @@ curl
https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hug
```
#### 3.3 Source code compilation
+Please ensure that the wget command is installed before compiling the source
code
We could get HugeGraph **source code** by 2 ways: (So as the other HugeGraph
repos/modules)
- download the stable/release version from the ASF site
diff --git a/content/en/docs/quickstart/hugegraph-tools.md
b/content/en/docs/quickstart/hugegraph-tools.md
index 765f37d6..c5e7ba86 100644
--- a/content/en/docs/quickstart/hugegraph-tools.md
+++ b/content/en/docs/quickstart/hugegraph-tools.md
@@ -25,6 +25,7 @@ tar zxf *hugegraph*.tar.gz
```
#### 2.2 Clone source code to compile and install
+Please ensure that the wget command is installed before compiling the source
code
Download the latest version of the HugeGraph-Tools source package:
