Skip to content

Commit

Permalink
doc(hubble): enhance hubble usage doc/command (#333)
Browse files Browse the repository at this point in the history
  • Loading branch information
returnToInnocence committed May 29, 2024
1 parent 2d6187e commit 95648c2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 42 deletions.
23 changes: 2 additions & 21 deletions content/cn/docs/quickstart/hugegraph-hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,26 +112,7 @@ starting HugeGraphHubble ..............timed out with http status 502

#### 2.3 源码编译

**注意:** 编译 hubble 需要用户本地环境有安装 `Nodejs V16.x``yarn` 环境

```bash
apt install curl build-essential
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
source ~/.bashrc
nvm install 16
```

然后确认安装版本是否为 `16.x` (请注意过高的 Node 版本会产生冲突)

```bash
node -v
```

使用下列命令安装 `yarn`

```bash
npm install -g yarn
```
**注意:** 目前已在 `hugegraph-hubble/hubble-be/pom.xml` 中引入插件 `frontend-maven-plugin`,编译 hubble 时不需要用户本地环境提前安装 `Nodejs V16.x``yarn` 环境,可直接按下述步骤执行

下载 toolchain 源码包

Expand All @@ -142,7 +123,7 @@ git clone https://github.com/apache/hugegraph-toolchain.git
编译`hubble`, 它依赖 loader 和 client, 编译时需提前构建这些依赖 (后续可跳)

```shell
cd incubator-hugegraph-toolchain
cd hugegraph-toolchain
sudo pip install -r hugegraph-hubble/hubble-dist/assembly/travis/requirements.txt
mvn install -pl hugegraph-client,hugegraph-loader -am -Dmaven.javadoc.skip=true -DskipTests -ntp

Expand Down
23 changes: 2 additions & 21 deletions content/en/docs/quickstart/hugegraph-hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,26 +123,7 @@ Then use a web browser to access `ip:8088` and you can see the `Hubble` page. Yo

#### 2.3 Source code compilation

**Note**: Compiling Hubble requires the user's local environment to have Node.js V16.x and yarn installed.

```bash
apt install curl build-essential
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
source ~/.bashrc
nvm install 16
```

Then, verify that the installed Node.js version is 16.x (please note that higher Node version may cause conflicts).

```bash
node -v
```

install `yarn` by the command below:

```bash
npm install -g yarn
```
**Note**: The plugin `frontend-maven-plugin` has been added to `hugegraph-hubble/hubble-be/pom.xml`. To compile hubble, you do not need to install `Nodejs V16.x` and `yarn` environment in your local environment in advance. You can directly execute the following steps.

Download the toolchain source code.

Expand All @@ -153,7 +134,7 @@ git clone https://github.com/apache/hugegraph-toolchain.git
Compile `hubble`. It depends on the loader and client, so you need to build these dependencies in advance during the compilation process (you can skip this step later).

```shell
cd incubator-hugegraph-toolchain
cd hugegraph-toolchain
sudo pip install -r hugegraph-hubble/hubble-dist/assembly/travis/requirements.txt
mvn install -pl hugegraph-client,hugegraph-loader -am -Dmaven.javadoc.skip=true -DskipTests -ntp
cd hugegraph-hubble
Expand Down

0 comments on commit 95648c2

Please sign in to comment.