Updatedoc (vesoft-inc#807)

* add create-tag-edge, show and update get-started * update * update * update * update * add FAQ * update * update * update * update * file structure * add create-tag-edge, show and update get-started * update * add FAQ * update * update * update * update * file structure * change build * update * update * update * update * update * last update * update * update * update doc * update * update * update * update
BradyBromley · Aug 20, 2019 · 0065959 · 0065959
1 parent a830d90
commit 0065959
Show file tree

Hide file tree

Showing 32 changed files with 342 additions and 187 deletions.
diff --git a/README-CN.md b/README-CN.md
@@ -0,0 +1,47 @@
+<p align="center">
+  <img src="docs/logo.png"/>
+  <br>中文 | <a href="README.md">English</a>
+  <br>世界上唯一能够容纳千亿个顶点和万亿条边，并提供毫秒级查询延时的图数据库解决方案<br>
+</p>
+
+<p align="center">
+  <a href="https://mp.weixin.qq.com/mp/profile_ext?action=home&__biz=MzU2NDkxNjI0NQ==&scene=124#wechat_redirect"><img src="https://img.shields.io/badge/WeChat-%E5%85%AC%E4%BC%97%E5%8F%B7-brightgreen" alt="WeiXin"></a>
+  <a href="https://www.zhihu.com/org/nebulagraph/activities"><img src="https://img.shields.io/badge/Zhihu-%E7%9F%A5%E4%B9%8E-blue" alt="Zhihu"></a>
+  <a href="https://segmentfault.com/t/nebula"><img src="https://img.shields.io/badge/SegmentFault-%E6%80%9D%E5%90%A6-green" alt="SegmentFault"></a>
+  <a href="https://weibo.com/p/1006067122684542/home?from=page_100606&mod=TAB#place"><img src="https://img.shields.io/badge/Weibo-%E5%BE%AE%E5%8D%9A-red" alt="Sina Weibo"></a>
+</p>
+
+**Nebula Graph** 的目标是为超大规模图数据提供高并发，低延时的读、写及计算。Nebula是一个开源项目，我们期待与社区合作共同推广图数据库。
+
+**Nebula Graph** 的主要特点：
+
+ * 全对称分布式架构
+ * 可扩展
+ * 高可用
+ * 数据强一致
+ * 类 SQL 查询语言
+
+## 获取 `Nebula` ##
+
+除编译源代码外，也可使用 [Nebula Graph 镜像](https://hub.docker.com/r/vesoft/nebula-graph/tags) 进行试用。
+更多详情参见 [Get Started](docs/manual-CN/get-started.md).
+
+## 参与 `Nebula` ##
+
+**Nebula Graph** 是一个完全开源的项目，欢迎开源爱好者参与 Nebula 社区，目前有以下贡献方式：
+
+* 试用 **Nebula Graph** 并给出反馈
+* 提交功能需求或者 issue
+* 贡献代码，详情请参见 [How to Contribute](docs/manual-CN/how-to-contribute.md)
+* 帮助我们完善文档，详情参见 [Contribute to Nebula Graph Docs](docs/manual-CN/contribute-to-documentation.md)
+
+## 许可证 ###
+
+**Nebula Graph** 使用 [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) 许可证，您可以免费下载，修改以及部署源代码。您还可以将 **Nebula Graph** 作为后端服务部署以支持您的 SaaS 部署。
+
+为防止云供应商从项目赢利而不回馈，Nebula 在项目中添加了 [Commons Clause 1.0](https://commonsclause.com/) 条款。如上所述，Nebula 是一个完全开源的项目，欢迎您就许可模式提出建议，帮助 Nebula 社区更好地发展。
+
+## 联系方式
+- 使用 [GitHub issue tracker](https://github.com/vesoft-inc/nebula/issues) 提交 issue 或功能需求。
+- 加入 [![](https://img.shields.io/badge/slack-nebula-519dd9.svg)](https://nebulagraph.slack.com/archives/DJQC9P0H5/p1557815158000200)。
+- 访问官网 [Home Page](http://nebula-graph.io/)。
diff --git a/README-EN.md b/README-EN.md
diff --git a/README.md b/README.md
@@ -1,44 +1,46 @@
 <p align="center">
   <img src="docs/logo.png"/>
-  <br>中文 | <a href="README-EN.md">English</a>
-  <br>世界上唯一能够容纳千亿个顶点和万亿条边，并提供毫秒级查询延时的图数据库解决方案<br>
+  <br> English | <a href="README-CN.md">中文</a>
+  <br>A distributed, scalable, lighting-fast graph database<br>
 </p>
 
-<p align="center">
+<!-- <p align="center">
   <a href="https://mp.weixin.qq.com/mp/profile_ext?action=home&__biz=MzU2NDkxNjI0NQ==&scene=124#wechat_redirect"><img src="https://img.shields.io/badge/%E5%85%AC%E4%BC%97%E5%8F%B7-wechat-brightgreen" alt="WeiXin"></a>
   <a href="https://www.zhihu.com/org/nebulagraph/activities"><img src="https://img.shields.io/badge/%E7%9F%A5%E4%B9%8E-zhihu-blue" alt="Zhihu"></a>
     <a href="https://weibo.com/p/1006067122684542/home?from=page_100606&mod=TAB#place"><img src="https://img.shields.io/badge/%E5%BE%AE%E5%8D%9A-weibo-red" alt="Sina Weibo"></a>
-</p>
+</p> -->
+
+## Nebula
 
-**Nebula Graph** 的目标是为超大规模图数据提供高并发，低延时的读、写及计算。Nebula是一个开源项目，我们期待与社区合作共同推广图数据库。
+**Nebula** is the only solution in the world capable to host graphs with dozens of billions of vertices (nodes) and trillions of edges, while still provides millisecond latency.
 
-**Nebula Graph** 的主要特点：
+**Nebula's** goal is to provide reading, writing, and computing with high concurrency, low latency for super large scale graphs. Nebula is an open source project and we are looking forward to working with the community to popularize and promote the graph database.
 
- * shared-nothing distributed
- * 对称分布
- * 可扩展
- * 高容错
- * 类似SQL的查询语言
+As a graph database, **Nebula** has these features
+* Symmetrically distributed
+* Highly scalable
+* Fault tolerant
+* Strong data consistency
+* SQL-like query language
 
-## 获取 `Nebula` ##
+## How can I get Nebula ##
+Apart from installing **Nebula Graph** from source code, you can use the [official Nebula Graph image](https://hub.docker.com/r/vesoft/nebula-graph/tags). For more details on how to install Nebula Graph, see [Get Started](docs/get-started.md).
 
-**Nebula Graph** 源码参见[GitHub](https://github.com/vesoft-inc/nebula)。
-也可下载Nebula [Docker](https://hub.docker.com/r/vesoft/nebula-graph/tags)镜像进行试用。
-更多详情参见[Get Started](get-started.md).
+## How can I contribute ##
+As the team behind **Nebula**, we fully commit to the community and all-in to the open source project. All the core features are and will be implemented in the open source repository.
 
-## 参与 `Nebula` ##
+We also encourage the community to involve the project. There are a few ways you can contribute:
 
-**Nebula Graph** 是一个完全开源的项目，其所有核心功能都将在开源repository中实现。Nebula鼓励社区参与该项目，目前有以下贡献方式：
+* You can download and try **Nebula**, and provide us feedbacks
+* You can submit your feature requirements and bug reports
+* You can perfectionate documentations
+* You can fix bugs or implement features. More details on how to build the project and submit the Pull Requests click [`how-to-contribute`](https://github.com/vesoft-inc/nebula/blob/master/docs/how-to-contribute.md).
 
-* 直接下载试用 **Nebula Graph** 并给出反馈
-* 提交功能要求和错误报告
-* 帮助我们完善文档，详情参见[Contribute to Nebula Graph Docs](cn-contribute-to-documentation.md)
+## Licensing ###
+**Nebula** is under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license, so you can freely download, modify, deploy the source code to meet your needs. You can also freely deploy **Nebula** as a back-end service to support your SaaS deployment.
 
-## 许可 ###
-**Nebula Graph** 使用[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)许可，您可以免费下载，修改，部署源代码以满足您的需求。您还可以将 **Nebula Graph** 作为后端服务部署以支持您的SAAS部署。
+In order to prevent cloud providers monetizing from the project without contributing back, we added [Commons Clause 1.0](https://commonsclause.com/) to the project. As mentioned above, we fully commit to the open source community. We would love to hear your thoughts on the licensing model and are willing to make it more suitable for the community.
 
-为防止云供应商从项目赢利而不回馈，Nebula在项目中添加了[Common Clause 1.0](https://commonsclause.com/)条款。如上所述，Nebula是一个完全开源的项目，欢迎您就许可模式提议，帮助Nebula更适合社区发展。
-## 联系方式
-- 使用[GitHub issue tracker](https://github.com/vesoft-inc/nebula/issues) 提交错误报告和功能要求。
-- 加入 [![](https://img.shields.io/badge/slack-nebula-519dd9.svg)](https://nebulagraph.slack.com/archives/DJQC9P0H5/p1557815158000200)。
-- **Nebula Graph** 详情访问[Home Page](http://nebula-graph.io/)。
+## Contact
+- Please use [`GitHub issue tracker`](https://github.com/vesoft-inc/nebula/issues) for filling bugs or feature requests.
+- Join [![](https://img.shields.io/badge/slack-nebula-519dd9.svg)](https://nebulagraph.slack.com/archives/DJQC9P0H5/p1557815158000200).
diff --git a/docs/deploy-cluster.md b/docs/deploy-cluster.md
@@ -6,17 +6,15 @@ This tutorial provides an introduction to deploy `Nebula` cluster.
 
 #### Download and install package
 
-First at all, you can download rpm or deb from [Here](https://github.com/vesoft-inc/nebula/releases).
+Currently, we have offered packages for `CentOS 7.5`, `CentOS 6.5`, `Ubuntu 1604` and `Ubuntu 1804`. You can download rpm or deb packages [here](https://github.com/vesoft-inc/nebula/releases).
 
-Currently, we have offered `CentOS 7.5`, `CentOS 6.5`, `Ubuntu 1604` and `Ubuntu 1804`'s installation package.
-
-For `CentOS`:
+For `CentOS` :
 
 ```
 rpm -ivh nebula-{VERSION}.{SYSTEM_VERSION}.x86_64.rpm
 ```
 
-For `Ubuntu`:
+For `Ubuntu` :
 
 ```
 dpkg -i nebula-{VERSION}.{SYSTEM_VERSION}.amd64.deb

diff --git a/docs/get-started.md b/docs/get-started.md
@@ -152,8 +152,8 @@ Then run the following command:
 
    - local_ip
    - port
-   - ws_http_port metaservice HTTP
-   - ws_h2_port metaservice HTTP2
+   - ws_http_port: metaservice HTTP port
+   - ws_h2_port: metaservice HTTP2 port
 
 
 * Configure nebula-storaged.conf
@@ -166,8 +166,8 @@ Then run the following command:
 
    - local_ip
    - port
-   - ws_http_port storageservice HTTP
-   - ws_h2_port storageservice HTTP2
+   - ws_http_port: storageservice HTTP port
+   - ws_h2_port: storageservice HTTP2 port
 
 * Configure nebula-graphd.conf
 
@@ -179,8 +179,8 @@ Then run the following command:
 
    - local_ip
    - port
-   - ws_http_port graphservice HTTP
-   - ws_h2_port graphservice HTTP2
+   - ws_http_port: graphservice HTTP port
+   - ws_h2_port: graphservice HTTP2 port
 
 **Start Service**
 

diff --git a/docs/how-to-build.md b/docs/how-to-build.md
@@ -40,12 +40,12 @@ The project itself includes the source code of several 3rd-party libraries, whic
   - zstd
 
 ### How to get 3rd-party Libraries
-[Install guide](https://github.com/vesoft-inc/nebula-3rdparty/blob/master/README.md)
 
+Please refer to [Installation Guide](https://github.com/vesoft-inc/nebula-3rdparty/blob/master/README.md)
 
 ### How to build
-  - 1. create build dir : `cd nebula && mkdir build && cd build`
-  - 2. generate makefile : `cmake -DNEBULA_THIRDPARTY_ROOT=${3rd-party_install_root} ..`
-  - 3. make : `make or make -j${threadnum}`
-  - 4. install: `make install`
+  - create build dir: `cd nebula && mkdir build && cd build`
+  - generate makefile: `cmake -DNEBULA_THIRDPARTY_ROOT=${3rd-party_install_root} ..`
+  - make: `make or make -j${threadnum}`
+  - install: `make install`
   - notes : the default installation dir is **/usr/local/**, if you want to change the dir, on step 2, your command can be `cmake -DCMAKE_INSTALL_PREFIX=$your_nebula_install_dir ..`
diff --git a/docs/how-to-contribute.md b/docs/how-to-contribute.md
@@ -14,10 +14,10 @@ Define a local working directory:
 working_dir=$HOME/Workspace
 ```
 
-Set `user` to match your github profile name:
+Set `user` to match your Github profile name:
 
 ```sh
-user={your github profile name}
+user={your Github profile name}
 ```
 
 Create your clone:
@@ -73,7 +73,7 @@ git checkout master
 git rebase upstream/master
 ```
 
-Branch from master:
+Checkout a new branch from master:
 
 ```sh
 git checkout -b myfeature
@@ -95,7 +95,7 @@ git push --force origin master
 
 #### Edit the code
 
-You can now edit the code on the `myfeature` branch. Please follow the coding style guidance [here](/cpp-coding-style/).
+You can now edit the code on the `myfeature` branch. We are following [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
 
 #### Run stand-alone mode
 
@@ -118,7 +118,7 @@ nebula
 #### Run Test
 
 ```sh
-# Run unit test to make sure all test passed.
+# Run unit test to make sure all tests passed.
 ```
 
 ### Step 5: Keep your branch in sync
@@ -156,13 +156,5 @@ git push -f origin myfeature
 
 ### Step 9: Get a code review
 
-Once your pull request has been opened, it will be assigned to at least one
-reviewers. Those reviewers will do a thorough code review, looking for
-correctness, bugs, opportunities for improvement, documentation and comments,
-and style.
-
-Commit changes made in response to review comments to the same branch on your
-fork.
-
-Very small PRs are easy to review. Very large PRs are very difficult to
-review.
+Once your pull request has been opened, it will be assigned to at least two
+reviewers. Those reviewers will do a thorough code review to ensure the changes meet the repository's contributing guidelines and other quality standards.
diff --git a/docs/manual-CN/contribute-to-documentation.md b/docs/manual-CN/contribute-to-documentation.md
@@ -2,14 +2,14 @@
 ---
 ## 贡献文档
 
-Nebula文档完全开源，我们欢迎更多贡献者帮助改进文档。Nebula文档使用Markdown语言，并参考了[Google开发者文档风格指南](https://developers.google.com/style/)进行编写。
+Nebula 文档完全开源，我们欢迎更多贡献者帮助改进文档。Nebula 文档使用 Markdown 语言，并参考了 [Google开发者文档风格指南](https://developers.google.com/style/) 进行编写。
 
 ## 如何贡献
 
 贡献文档有多种方式：
 
  - 使用每页右侧的铅笔标记直接在网站编辑或提交问题。
 
- - 在GitHub上提[issue](https://github.com/vesoft-inc/nebula/issues)。
+ - 在 GitHub 上提 [issue](https://github.com/vesoft-inc/nebula/issues)。
 
  - Fork仓库，在本地分支上做更改，然后提交PR。
diff --git a/docs/manual-CN/functions-and-operators/logical-operators.md b/docs/manual-CN/functions-and-operators/logical-operators.md
@@ -7,7 +7,7 @@
 |   \|\|   |   逻辑或 OR   | 
 
 
-在 nGQL 中, 非 0 数字将被视为 _true_. 逻辑运算符的优先级参见 [Operator Precedence](./Operator_Precedence.md)。
+在 nGQL 中, 非 0 数字将被视为 _true_. 逻辑运算符的优先级参见 [Operator Precedence](./operator-precedence.md)。
 
 * &&
 

diff --git a/docs/manual-CN/functions-and-operators/operator-precedence.md b/docs/manual-CN/functions-and-operators/operator-precedence.md
@@ -3,13 +3,13 @@
 下面的列表展示了 nGQL 运算符的优先级（降序）。同一行的运算符拥有一致的优先级。
 ```
 !
-- (unary minus)
+- (减法)
 *, /, %
 -, +
 == , >=, >, <=, <, <>, !=
 &&
 ||
-= (assignment)
+= (赋值)
 ```
 
 在一个表达式中，同等优先级的运算符将按照从左到右的顺序执行，唯一例外是赋值按照从右往左的顺序执行。但是，可以使用括号来修改执行顺序。
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ @@
     |   \|\|   |   逻辑或 OR   |
-    在 nGQL 中, 非 0 数字将被视为 _true_. 逻辑运算符的优先级参见 [Operator Precedence](./Operator_Precedence.md)。
+    在 nGQL 中, 非 0 数字将被视为 _true_. 逻辑运算符的优先级参见 [Operator Precedence](./operator-precedence.md)。
     * &&
@@ Expand Down @@