You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by zh...@apache.org on 2022/11/28 02:57:45 UTC
[incubator-hugegraph-doc] branch master updated: improve computer doc (#157)
This is an automated email from the ASF dual-hosted git repository.
zhaocong 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 862b048f improve computer doc (#157)
862b048f is described below
commit 862b048fc25e8a2f89ba8db5a40e7f5f0e96e4bd
Author: Cong Zhao <zh...@apache.org>
AuthorDate: Mon Nov 28 10:57:39 2022 +0800
improve computer doc (#157)
---
content/cn/docs/config/config-computer.md | 2 +-
content/cn/docs/quickstart/hugegraph-computer.md | 14 +++++++-------
content/en/docs/config/config-computer.md | 2 +-
content/en/docs/quickstart/hugegraph-computer.md | 20 ++++++++++----------
4 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/content/cn/docs/config/config-computer.md b/content/cn/docs/config/config-computer.md
index 360611d5..07779bfd 100644
--- a/content/cn/docs/config/config-computer.md
+++ b/content/cn/docs/config/config-computer.md
@@ -140,7 +140,7 @@ weight: 5
| workerCpu | | The cpu limit of worker, the unit can be 'm' or without unit detail please refer to：[https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) | false |
| masterMemory | | The memory limit of master, the unit can be one of Ei、Pi、Ti、Gi、Mi、Ki detail please refer to：[https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) | false |
| workerMemory | | The memory limit of worker, the unit can be one of Ei、Pi、Ti、Gi、Mi、Ki detail please refer to：[https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) | false |
-| log4jXml | | The log4j.xml path for computer job. | false |
+| log4jXml | | The content of log4j.xml for computer job. | false |
| jarFile | | The jar path of computer algorithm. | false |
| remoteJarUri | | The remote jar uri of computer algorithm, it will overlay algorithm image. | false |
| jvmOptions | | The java startup parameters of computer job. | false |
diff --git a/content/cn/docs/quickstart/hugegraph-computer.md b/content/cn/docs/quickstart/hugegraph-computer.md
index c28f080e..d3f4597f 100644
--- a/content/cn/docs/quickstart/hugegraph-computer.md
+++ b/content/cn/docs/quickstart/hugegraph-computer.md
@@ -6,7 +6,7 @@ weight: 7
## 1 HugeGraph-Computer 概述
-`HugeGraph-Computer` 是分布式图处理系统 (OLAP). 它是 [Pregel](https://kowshik.github.io/JPregel/pregel_paper.pdf) 的一个实现. 它可以运行在 Kubernetes 上。
+[`HugeGraph-Computer`](https://github.com/apache/incubator-hugegraph-computer) 是分布式图处理系统 (OLAP). 它是 [Pregel](https://kowshik.github.io/JPregel/pregel_paper.pdf) 的一个实现. 它可以运行在 Kubernetes 上。
### 特性
@@ -26,13 +26,13 @@ weight: 7
>
> 还需要首先部署 HugeGraph-Server 和 [Etcd](https://etcd.io/docs/v3.5/quickstart/).
-#### 2.1 Download the compiled archive
-
有两种方式可以获取 HugeGraph-Computer：
- 下载已编译的压缩包
- 克隆源码编译打包
+#### 2.1 Download the compiled archive
+
下载最新版本的 HugeGraph-Computer release 包：
```bash
@@ -192,9 +192,9 @@ kubectl get event --field-selector reason=ComputerJobSucceed --field-selector in
如果输出到 `Hugegraph-Server` 则与 Locally 模式一致，如果输出到 `HDFS` ，请检查 `hugegraph-computerresults{jobId}`目录下的结果文件。
-### 3 内置算法文档
+## 3 内置算法文档
-#### 3.1 支持的算法列表:
+### 3.1 支持的算法列表:
###### 中心性算法:
@@ -218,10 +218,10 @@ kubectl get event --field-selector reason=ComputerJobSucceed --field-selector in
更多算法请看: [Built-In algorithms](https://github.com/apache/hugegraph-computer/tree/master/computer-algorithm/src/main/java/org/apache/hugegraph/computer/algorithm)
-#### 3.2 算法描述
+### 3.2 算法描述
TODO
-### 4 算法开发指南
+## 4 算法开发指南
TODO
\ No newline at end of file
diff --git a/content/en/docs/config/config-computer.md b/content/en/docs/config/config-computer.md
index 815b91d4..b6c60202 100644
--- a/content/en/docs/config/config-computer.md
+++ b/content/en/docs/config/config-computer.md
@@ -140,7 +140,7 @@ weight: 5
| workerCpu | | The cpu limit of worker, the unit can be 'm' or without unit detail please refer to：[https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) | false |
| masterMemory | | The memory limit of master, the unit can be one of Ei、Pi、Ti、Gi、Mi、Ki detail please refer to：[https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) | false |
| workerMemory | | The memory limit of worker, the unit can be one of Ei、Pi、Ti、Gi、Mi、Ki detail please refer to：[https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) | false |
-| log4jXml | | The log4j.xml path for computer job. | false |
+| log4jXml | | The content of log4j.xml for computer job. | false |
| jarFile | | The jar path of computer algorithm. | false |
| remoteJarUri | | The remote jar uri of computer algorithm, it will overlay algorithm image. | false |
| jvmOptions | | The java startup parameters of computer job. | false |
diff --git a/content/en/docs/quickstart/hugegraph-computer.md b/content/en/docs/quickstart/hugegraph-computer.md
index af610357..81f885c1 100644
--- a/content/en/docs/quickstart/hugegraph-computer.md
+++ b/content/en/docs/quickstart/hugegraph-computer.md
@@ -6,7 +6,7 @@ weight: 7
## 1 HugeGraph-Computer Overview
-The `HugeGraph-Computer` is a distributed graph processing system for HugeGraph (OLAP). It is an implementation of [Pregel](https://kowshik.github.io/JPregel/pregel_paper.pdf). It runs on Kubernetes framework.
+The [`HugeGraph-Computer`](https://github.com/apache/incubator-hugegraph-computer) is a distributed graph processing system for HugeGraph (OLAP). It is an implementation of [Pregel](https://kowshik.github.io/JPregel/pregel_paper.pdf). It runs on Kubernetes framework.
### Features
@@ -20,17 +20,17 @@ The `HugeGraph-Computer` is a distributed graph processing system for HugeGraph
## 2 Get Started
-There are two ways to get HugeGraph-Computer:
-
-- Download the compiled tarball
-- Clone source code then compile and package
-
### 2.1 Run PageRank algorithm locally
> To run algorithm with HugeGraph-Computer, you need to install 64-bit JRE/JDK 11 or later versions.
>
> You also need to deploy HugeGraph-Server and [Etcd](https://etcd.io/docs/v3.5/quickstart/).
+There are two ways to get HugeGraph-Computer:
+
+- Download the compiled tarball
+- Clone source code then compile and package
+
#### 2.1 Download the compiled archive
Download the latest version of the HugeGraph-Computer release package:
@@ -192,9 +192,9 @@ kubectl get event --field-selector reason=ComputerJobSucceed --field-selector in
If the output to `Hugegraph-Server` is consistent with Locally, if output to `HDFS`, please check the result file in the directory of `/hugegraph-computer/results/{jobId}` directory.
-### 3 Built-In algorithms document
+## 3 Built-In algorithms document
-#### 3.1 Supported algorithms list:
+### 3.1 Supported algorithms list:
###### Centrality Algorithm:
@@ -218,10 +218,10 @@ If the output to `Hugegraph-Server` is consistent with Locally, if output to `HD
More algorithms please see: [Built-In algorithms](https://github.com/apache/hugegraph-computer/tree/master/computer-algorithm/src/main/java/org/apache/hugegraph/computer/algorithm)
-#### 3.2 Algorithm describe
+### 3.2 Algorithm describe
TODO
-### 4 Algorithm development guide
+## 4 Algorithm development guide
TODO
\ No newline at end of file