change desc

apache · Dec 16, 2023 · c165aac · c165aac
1 parent b5f5c65
commit c165aac
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 38 deletions.
diff --git a/content/cn/docs/quickstart/hugegraph-hubble.md b/content/cn/docs/quickstart/hugegraph-hubble.md
@@ -38,7 +38,7 @@ HugeGraph 是一款面向分析型，支持批量操作的图数据库系统，
 
 - 下载 toolchain 二进制包
 - 源码编译
-- 使用 docker
+- 使用 docker (便于**测试**)
 
 #### 2.1 下载 toolchain 二进制包
 
@@ -115,11 +115,7 @@ cd apache-hugegraph-hubble-incubating*
 bin/start-hubble.sh -d
 ```
 
-#### 2.3 使用 Docker
-
-> 注意：hugegraph-hubble 的 docker 镜像是一个便捷版本，用于快速启动 hubble，并不是 ASF 官方发布版。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
-
-> 注意：推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
+#### 2.3 使用 Docker (便于**测试**)
 
 > **特别注意**: docker 模式下，若 hubble 和 server 在同一宿主机，hubble 页面中设置 graph 的 `hostname` **不能设置**为 `localhost/127.0.0.1`，因这会指向 hubble **容器内部**而非宿主机，导致无法连接到 server.
 > 
@@ -147,6 +143,12 @@ services:
       - 8088:8088
 ```
 
+> 注意：
+>
+> 1. hugegraph-hubble 的 docker 镜像是一个便捷版本，用于快速启动 hubble，并不是官方发布版。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
+>
+> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
+
 ### 3	平台使用流程
 
 平台的模块使用流程如下：

diff --git a/content/cn/docs/quickstart/hugegraph-loader.md b/content/cn/docs/quickstart/hugegraph-loader.md
@@ -26,7 +26,7 @@ HugeGraph-Loader 是 HugeGraph 的数据导入组件，能够将多种数据源
 
 - 下载已编译的压缩包
 - 克隆源码编译安装
-- 使用 Docker 镜像
+- 使用 Docker 镜像 (便于**测试**)
 
 #### 2.1 下载已编译的压缩包
 
@@ -66,13 +66,7 @@ cd hugegraph-loader
 mvn clean package -DskipTests
 ```
 
-#### 2.3 使用 Docker 镜像
-
-
-> 注意：hugegraph-loader 的 docker 镜像是一个便捷版本，用于快速启动 loader，并不是 ASF 官方发布版。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
-
-> 注意：推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
-
+#### 2.3 使用 Docker 镜像 (便于**测试**)
 
 我们可以使用 `docker run -itd --name loader hugegraph/loader`部署 loader 服务。对于需要加载的数据，则可以通过挂载 `-v /path/to/data/file:/loader/file` 或者`docker cp`的方式将文件复制到 loader 容器内部。
 
@@ -104,6 +98,13 @@ services:
 
 具体的数据导入流程可以参考 [4.5 使用 docker 导入](#45-使用-docker-导入) 
 
+
+> 注意：
+> 
+> 1. hugegraph-loader 的 docker 镜像是一个便捷版本，用于快速启动 loader，并不是官方发布版。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
+> 
+> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
+
 ### 3 使用流程
 
 使用 HugeGraph-Loader 的基本流程分为以下几步：

diff --git a/content/cn/docs/quickstart/hugegraph-server.md b/content/cn/docs/quickstart/hugegraph-server.md
@@ -30,7 +30,7 @@ java -version
 
 - 方式 1：下载 tar 包
 - 方式 2：源码编译
-- 方式 3：使用 Docker 容器
+- 方式 3：使用 Docker 容器 (便于**测试**)
 - 方式 4：使用 tools 工具部署 (Outdated)
 
 
@@ -86,13 +86,9 @@ mvn package -DskipTests
 
 执行成功后，在 hugegraph 目录下生成 `*hugegraph-*.tar.gz` 文件，就是编译生成的 tar 包。
 
-#### 3.3 使用 Docker 容器
+#### 3.3 使用 Docker 容器 (便于**测试**)
 <!-- 3.1 is linked by other place. if change 3.1's title, please check -->
 
-> 注意：hugegraph 的 docker 镜像是一个便捷版本，用于快速启动 hugegraph，并不是 ASF 官方发布版。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
-
-> 注意：推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
-
 可参考 [Docker 部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/README.md)。
 
 我们可以使用 `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`.
@@ -116,6 +112,12 @@ services:
       - 8080:8080
 ```
 
+> 注意：
+> 
+> 1. hugegraph 的 docker 镜像是一个便捷版本，用于快速启动 hugegraph，并不是官方发布版。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
+>
+> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
+
 #### 3.4 使用 tools 工具部署 (Outdated)
 
 HugeGraph-Tools 提供了一键部署的命令行工具，用户可以使用该工具快速地一键下载、解压、配置并启动 HugeGraph-Server 和 HugeGraph-Hubble，最新的 HugeGraph-Toolchain 中已经包含所有的这些工具，直接下载它解压就有工具包集合了

diff --git a/content/en/docs/quickstart/hugegraph-hubble.md b/content/en/docs/quickstart/hugegraph-hubble.md
@@ -38,7 +38,7 @@ There are three ways to deplot `hugegraph-hubble`
 
 - Download the Toolchain binary package
 - Source code compilation
-- Use Docker
+- Use Docker (Convenient for Test/Dev)
 
 #### 2.1 Download the Toolchain binary package
 
@@ -115,11 +115,7 @@ Run `hubble`
 bin/start-hubble.sh -d
 ```
 
-#### 2.3 Use docker
-
-> Note: The docker image of hugegraph-hubble is a convenience release to start hugegraph-hubble quickly, not official distribution artifacts from ASF. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub).
-
-> Note: Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
+#### 2.3 Use docker (Convenient for Test/Dev)
 
 > **Special Note**: If you are starting `hubble` with Docker, and `hubble` and the server are on the same host. When configuring the hostname for the graph on the Hubble web page, please do not directly set it to `localhost/127.0.0.1`. This will refer to the `hubble` container internally rather than the host machine, resulting in a connection failure to the server.
 >
@@ -147,6 +143,12 @@ services:
       - 8088:8088
 ```
 
+> Note: 
+>
+> 1. The docker image of hugegraph-hubble is a convenience release to start hugegraph-hubble quickly, not official distribution artifacts. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub).
+> 
+> 2. Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
+
 ### 3	Platform Workflow
 
 The module usage process of the platform is as follows:

diff --git a/content/en/docs/quickstart/hugegraph-loader.md b/content/en/docs/quickstart/hugegraph-loader.md
@@ -25,7 +25,7 @@ There are two ways to get HugeGraph-Loader:
 
 - Download the compiled tarball
 - Clone source code then compile and install
-- Use docker image
+- Use docker image (Convenient for Test/Dev)
 
 #### 2.1 Download the compiled archive
 
@@ -65,11 +65,7 @@ cd hugegraph-loader
 mvn clean package -DskipTests
 ```
 
-#### 2.3 Use Docker image
-
-> Note: The docker image of hugegraph-loader is a convenience release to start hugegraph-loader quickly, not official distribution artifacts from ASF. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub).
-
-> Note: Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
+#### 2.3 Use Docker image (Convenient for Test/Dev)
 
 We can deploy the loader service using `docker run -itd --name loader hugegraph/loader`. For the data that needs to be loaded, it can be copied into the loader container either by mounting `-v /path/to/data/file:/loader/file` or by using `docker cp`.
 
@@ -101,6 +97,11 @@ services:
 
 The specific data loading process can be referenced under [4.5 User Docker to load data](#45-use-docker-to-load-data) 
 
+> Note: 
+> 1. The docker image of hugegraph-loader is a convenience release to start hugegraph-loader quickly, not official distribution artifacts. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub).
+> 
+> 2. Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
+
 ### 3 How to use
 The basic process of using HugeGraph-Loader is divided into the following steps:
 - Write graph schema

diff --git a/content/en/docs/quickstart/hugegraph-server.md b/content/en/docs/quickstart/hugegraph-server.md
@@ -26,7 +26,7 @@ There are four ways to deploy HugeGraph-Server components:
 
 - Method 1: Download the binary tarball
 - Method 2: Source code compilation
-- Method 3: Use Docker container
+- Method 3: Use Docker container (Convenient for Test/Dev)
 - Method 4: One-click deployment
 
 
@@ -97,11 +97,7 @@ The execution log is as follows:
 
 After successful execution, `*hugegraph-*.tar.gz` files will be generated in the hugegraph directory, which is the tarball generated by compilation.
 
-#### 3.3 Use Docker container
-
-> Note: The docker image of hugegraph is a convenience release to start hugegraph quickly, not official distribution artifacts from ASF. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub).
-
-> Note: Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
+#### 3.3 Use Docker container (Convenient for Test/Dev)
 
 <!-- 3.1 is linked by other place. if change 3.1's title, please check -->
 You can refer to [Docker deployment guide](https://hub.docker.com/r/hugegraph/hugegraph).
@@ -126,6 +122,12 @@ services:
       - 8080:8080
 ```
 
+> Note: 
+>
+> 1. The docker image of hugegraph is a convenience release to start hugegraph quickly, not official distribution artifacts. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub).
+> 
+> 2. Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
+
 #### 3.4 One-click deployment
 
 `HugeGraph-Tools` provides a command-line tool for one-click deployment, users can use this tool to quickly download, decompress, configure and start `HugeGraphServer` and `HugeGraph-Hubble` with one click.