Merge pull request #1 from Amber1990Zhang/doc-migration

 doc migration

README-CN.md

@@ -0,0 +1,90 @@
+<p align="center">
+  <img src="docs/logo.png"/>
+  <br>中文 | <a href="README.md">English</a>
+  <br>世界上唯一能够容纳千亿个顶点和万亿条边，并提供毫秒级查询延时的图数据库解决方案<br>
+</p>
+
+<p align="center">
+  <a href="https://user-images.githubusercontent.com/38887077/67449282-4362b300-f64c-11e9-878f-7efc373e5e55.jpg"><img src="https://img.shields.io/badge/WeChat-%E5%BE%AE%E4%BF%A1-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>
+  <a href="http://githubbadges.com/star.svg?user=vesoft-inc&repo=nebula&style=default">
+    <img src="http://githubbadges.com/star.svg?user=vesoft-inc&repo=nebula&style=default" alt="nebula star"/>
+  </a>
+  <a href="http://githubbadges.com/fork.svg?user=vesoft-inc&repo=nebula&style=default">
+    <img src="http://githubbadges.com/fork.svg?user=vesoft-inc&repo=nebula&style=default" alt="nebula fork"/>
+  </a>
+  <a href="https://codecov.io/gh/vesoft-inc/nebula">
+    <img src="https://codecov.io/gh/vesoft-inc/nebula/branch/master/graph/badge.svg" alt="codecov"/>
+  </a>
+</p>
+
+# Nebula Graph是什么？
+
+**Nebula Graph** 是一款开源的图数据库，擅长处理千亿个顶点和万亿条边的超大规模数据集。
+
+与其他图数据库产品相比，**Nebula Graph** 具有如下优势：
+
+* 全对称分布式架构
+* 存储与计算分离
+* 水平可扩展性
+* RAFT 协议下的数据强一致
+* 类 SQL 查询语言
+* 用户鉴权
+
+## 产品路线图
+
+**Nebula Graph** 产品规划路线图请参见 [roadmap](https://github.com/vesoft-inc/nebula/wiki/Nebula-Graph-Roadmap-2019)。
+
+## 图可视化
+
+查看[图可视化](https://github.com/vesoft-inc/nebula-web-docker)，开启图数据可视化探索之旅。
+
+## 支持的客户端
+* [Go](https://github.com/vesoft-inc/nebula-go)
+* [Python](https://github.com/vesoft-inc/nebula-python)
+* [Java](https://github.com/vesoft-inc/nebula-java)
+
+## 快速使用
+
+请查看[快速使用手册](docs/manual-CN/1.overview/2.quick-start/1.get-started.md)，开始使用 **Nebula Graph**。
+
+在开始使用 **Nebula Graph** 之前，必须通过[编译源码](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/3.build-develop-and-administration/1.build/1.build-source-code.md)，[rpm/deb 包](https://github.com/vesoft-inc/nebula/tree/master/docs/manual-CN/3.build-develop-and-administration/3.deploy-and-administrations/deployment/install-with-rpm-deb.md) 或者 [docker compose](https://github.com/vesoft-inc/nebula-docker-compose) 方式安装 **Nebula Graph**。您也可以观看[视频](https://space.bilibili.com/472621355)学习如何安装 **Nebula Graph**。
+
+## 获取帮助
+
+在使用 **Nebula Graph** 过程中遇到任何问题，都可以通过下面的方式寻求帮助：
+
+* [知乎](https://www.zhihu.com/org/nebulagraph/activities)
+* [SegmentFault](https://segmentfault.com/t/nebula)
+* [官方论坛](https://discuss.nebula-graph.io)
+
+## 文档
+
+* [简体中文](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-CN/README.md)
+* [English](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/README.md)
+
+## Nebula Graph 产品架构图
+
+![image](https://github.com/vesoft-inc/nebula-docs/raw/master/images/Nebula%20Arch.png)
+
+## 如何贡献
+
+**Nebula Graph** 是一个完全开源的项目，欢迎开源爱好者通过以下方式参与到 **Nebula Graph** 社区：
+* 从标记为 [good first issues](https://github.com/vesoft-inc/nebula/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 的问题入手
+* 贡献代码，详情请参见 [如何贡献](docs/manual-CN/4.contributions/how-to-contribute.md)
+* 直接在GitHub上提 [Issue](https://github.com/vesoft-inc/nebula/issues)
+
+## 许可证
+
+**Nebula Graph** 使用 [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) 许可证，您可以免费下载，修改以及部署源代码。您还可以将 **Nebula Graph** 作为后端服务部署以支持您的 SaaS 部署。
+
+为防止云供应商从项目赢利而不回馈，**Nebula Graph** 在项目中添加了 [Commons Clause 1.0](https://commonsclause.com/) 条款。如上所述，**Nebula Graph** 是一个完全开源的项目，欢迎您就许可模式提出建议，帮助 **Nebula Graph** 社区更好地发展。
+
+## 联系方式
+
+* 访问官网 [Home Page](http://nebula-graph.io/)。
+* [![WeiXin](https://img.shields.io/badge/WeChat-%E5%BE%AE%E4%BF%A1-brightgreen)](https://user-images.githubusercontent.com/38887077/67449282-4362b300-f64c-11e9-878f-7efc373e5e55.jpg)
+* [![Sina Weibo](https://img.shields.io/badge/Weibo-%E5%BE%AE%E5%8D%9A-red)](https://weibo.com/p/1006067122684542/home?from=page_100606&mod=TAB#place)
+* email: info@vesoft.com

README.md

@@ -0,0 +1,96 @@
+<p align="center">
+  <img src="docs/logo.png"/>
+  <br> English | <a href="README-CN.md">中文</a>
+  <br>A distributed, scalable, lightning-fast graph database<br>
+</p>
+<p align="center">
+  <a href="https://github.com/vesoft-inc/nebula/actions?workflow=build">
+    <img src="https://github.com/vesoft-inc/nebula/workflows/build/badge.svg" alt="build and test workflow"/>
+  </a>
+  <a href="https://hub.docker.com/u/vesoft">
+    <img src="https://github.com/vesoft-inc/nebula/workflows/docker/badge.svg" alt="build docker image workflow"/>
+  </a>
+  <a href="https://github.com/vesoft-inc/nebula/actions?workflow=package">
+    <img src="https://github.com/vesoft-inc/nebula/workflows/package/badge.svg" alt="make nebula packages workflow"/>
+  </a>
+  <a href="http://githubbadges.com/star.svg?user=vesoft-inc&repo=nebula&style=default">
+    <img src="http://githubbadges.com/star.svg?user=vesoft-inc&repo=nebula&style=default" alt="nebula star"/>
+  </a>
+  <a href="http://githubbadges.com/fork.svg?user=vesoft-inc&repo=nebula&style=default">
+    <img src="http://githubbadges.com/fork.svg?user=vesoft-inc&repo=nebula&style=default" alt="nebula fork"/>
+  </a>
+  <a href="https://codecov.io/gh/vesoft-inc/nebula">
+    <img src="https://codecov.io/gh/vesoft-inc/nebula/branch/master/graph/badge.svg" alt="codecov"/>
+  </a>
+  <br>
+</p>
+
+# What is Nebula Graph?
+
+**Nebula Graph** is an open-source graph database capable of hosting super large scale graphs with dozens of billions of vertices (nodes) and trillions of edges, with milliseconds of latency.
+
+Compared with other graph database solutions, **Nebula Graph** has the following advantages:
+
+* Symmetrically distributed
+* Storage and computing separation
+* Horizontal scalability
+* Strong data consistency by RAFT protocol
+* SQL-like query language
+* Role-based access control for higher level security
+
+## Roadmap
+
+See our [Roadmap](https://github.com/vesoft-inc/nebula/wiki/Nebula-Graph-Roadmap-2019) for what's coming soon in **Nebula Graph**.
+
+## Graph Visualization
+
+Visit [Graph Visualization](https://github.com/vesoft-inc/nebula-web-docker) for visual exploration of graph data on web UI.
+
+## Supported Clients
+* [Go](https://github.com/vesoft-inc/nebula-go)
+* [Python](https://github.com/vesoft-inc/nebula-python)
+* [Java](https://github.com/vesoft-inc/nebula-java)
+
+## Quick start
+
+Read the [Getting started](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/1.overview/2.quick-start/1.get-started.md) article for a quick start.
+
+Please note that you must install **Nebula Graph** by [installing source code](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/3.build-develop-and-administration/1.build/1.build-source-code.md), [rpm/deb packages](https://github.com/vesoft-inc/nebula/tree/master/docs/manual-EN/3.build-develop-and-administration/3.deploy-and-administrations/deployment/install-with-rpm-deb.md) or [docker compose](https://github.com/vesoft-inc/nebula-docker-compose), before you can actually start using it. If you prefer a video tutorial, visit our [YouTube channel](https://www.youtube.com/channel/UC73V8q795eSEMxDX4Pvdwmw).
+
+## Getting help
+
+In case you encounter any problems playing around **Nebula Graph**, please reach out for help:
+
+* [Slack channel](https://join.slack.com/t/nebulagraph/shared_invite/enQtNjIzMjQ5MzE2OTQ2LTM0MjY0MWFlODg3ZTNjMjg3YWU5ZGY2NDM5MDhmOGU2OWI5ZWZjZDUwNTExMGIxZTk2ZmQxY2Q2MzM1OWJhMmY#)
+* [Stack Overflow](https://stackoverflow.com/search?q=%5Bnebula-graph%5D&mixed=0)
+* [Official Forum](https://discuss.nebula-graph.io)
+
+## Documentation
+
+* [English](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/README.md)
+* [简体中文](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-CN/README.md)
+
+## Architecture
+
+![image](https://github.com/vesoft-inc/nebula-docs/raw/master/images/Nebula%20Arch.png)
+
+## Contributing
+
+Contributions are warmly welcomed and greatly appreciated. And here are a few ways you can contribute:
+
+* Start by some [good first issues](https://github.com/vesoft-inc/nebula/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+* Submit Pull Requests to us. See [how-to-contribute](docs/manual-EN/4.contributions/how-to-contribute.md).
+
+## Licensing
+
+**Nebula Graph** is under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license, so you can freely download, modify, and deploy the source code to meet your needs. You can also freely deploy **Nebula Graph** as a back-end service to support your SaaS deployment.
+
+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.
+
+## Contact
+
+* Twitter: [@NebulaGraph](https://twitter.com/NebulaGraph)
+* [Facebook page](https://www.facebook.com/NebulaGraph/)
+* [LinkedIn page](https://www.linkedin.com/company/vesoft-nebula-graph/)
+* [Slack channel](https://join.slack.com/t/nebulagraph/shared_invite/enQtNjIzMjQ5MzE2OTQ2LTM0MjY0MWFlODg3ZTNjMjg3YWU5ZGY2NDM5MDhmOGU2OWI5ZWZjZDUwNTExMGIxZTk2ZmQxY2Q2MzM1OWJhMmY#)
+* email: info@vesoft.com

docs/.gitignore

@@ -0,0 +1,2 @@
+*.pdf
+

docs/CNAME

@@ -0,0 +1 @@
+docs.nebula-graph.io

docs/README.md

@@ -0,0 +1,3 @@
+- [Manual](./manual-EN/README.md)
+
+- [中文手册](./manual-CN/README.md)

docs/doc-tools/README.md

@@ -0,0 +1,51 @@
+# Generate documentation in PDF
+
+This document teaches you how to make documentation in PDF.
+
+## Step One: Merge
+
+Use the provided script `merge-all.py` to merge all the markdown doc files into one.
+
+## Step Two: Generate TOC
+
+Use pandoc to generated TOC (table of content) for the file you just merged. Firstly, you should make sure that pandoc has been installed on your machine. Open your terminal and run the command:
+
+```bash
+pandoc -v
+```
+
+If pandoc is not installed, please install it first.
+
+**Windows**
+
+```bash
+choco install pandoc
+```
+
+**macOS**
+
+```bash
+brew install pandoc
+```
+
+If you have any questions on pandoc installation, please check its document [here](https://pandoc.org/installing.html).
+
+To generate TOC, you should first change directory to the merged file and type the following command:
+
+```bash
+pandoc -s --toc merged.md -o merged.md
+```
+
+**Note**: The default number of section levels is 3 in the table of contents (which means that level-1, 2, and 3 headings will be listed in the contents), use `--toc-depth=NUMBER` to specify that number.
+
+## Step Three: Generate PDF
+
+You can convert the merged markdown file into PDF and print it out for easy-reading. Use the following command to generate PDF:
+
+```bash
+pandoc merged.md  -o merged.pdf
+```
+
+**Note:** Make sure [MiKTeX](https://miktex.org/howto/install-miktex) is installed.
+
+Now you've got your PDF documentation and have fun with **Nebula Graph**.

docs/doc-tools/merge-all.py

@@ -0,0 +1,84 @@
+import os
+import sys
+
+# This script is to help you merge all the docs into one mardown file, then you can convert it into one pdf file and down load.
+
+
+def get_all_md_file_path(file_path):
+    if not os.path.isdir(file_path):
+        print(file_path+" is not a dir")
+    file_list_in_md = os.listdir(file_path)
+    file_list_md = []
+    for path_md in file_list_in_md:
+        if '.md' in path_md:
+            file_list_md.append(file_path + '/' + path_md)
+    # print(file_list_md)
+    return file_list_md
+
+
+def read_md_file(md_file_path):
+    with open(md_file_path) as f:
+        lines = f.readlines()
+    return lines
+
+
+def creat_md_file(file_name):
+    f = open(file_name, 'w')
+    f.write('\n')
+    f.close()
+
+
+def write_file(source_file_dir, dst_md_file):
+    with open(dst_md_file, 'a') as md_writor:
+        md_file_list = get_all_md_file_path(source_file_dir)
+        md_file_list.sort()
+        for file in md_file_list:
+            print('writing ' + file)
+            lines = read_md_file(file)
+            for line in lines:
+                md_writor.write(line)
+            md_writor.write('\n\n\n')
+
+
+def write_all(source_dir, dst_md_file):
+    file_list = os.listdir(source_dir)
+    dir_list = []
+    for path in file_list:
+        file_path = source_dir + '/' + path
+        if os.path.isdir(file_path):
+            dir_list.append(file_path)
+        elif os.path.isfile(path):
+            pass
+    write_file(source_dir, dst_md_file)
+    dir_list.sort()
+    for sub_dir in dir_list:
+        write_all(sub_dir, dst_md_file)
+
+
+if __name__ == "__main__":
+
+    # define these constants for reusability without commanline arguments
+    UNDEFINED = 'UNDEFINED'
+
+    # Output file
+    target_file = UNDEFINED
+    # Source file to be merged
+    source_dir = UNDEFINED
+
+    # argument 1 will be the source, argument 2 will be the target
+    if len(sys.argv) == 1:
+        sys.exit(
+            'usage: merge-all [target_file] [source_dir]'
+        )
+
+    elif len(sys.argv) != 3:
+        if target_file == UNDEFINED or source_dir == UNDEFINED:
+            sys.exit(
+                'error: target_file and source_dir not given in either scripts or commandline'
+            )
+    else:
+        target_file = sys.argv[1]
+        source_dir = sys.argv[2]
+
+    creat_md_file(target_file)
+    write_all(source_dir, target_file)

docs/manual-CN/0.about-this-manual.md

@@ -0,0 +1,31 @@
+# 关于本手册
+
+此手册为 **Nebula Graph** 的用户手册，版本为 R201910_RC1。详细版本更新信息参见 [Release Notes](https://github.com/vesoft-inc/nebula/releases)。
+
+## 面向的读者
+
+本手册适用于 `算法工程师`、`数据科学家`、`软件开发人员`和 `DBA`，以及所有对`图数据库`感兴趣的人群。
+
+如果在使用 **Nebula Graph** 的过程中有任何问题，欢迎在 [Nebula Graph Community Slack](https://join.slack.com/t/nebulagraph/shared_invite/enQtNjIzMjQ5MzE2OTQ2LTM0MjY0MWFlODg3ZTNjMjg3YWU5ZGY2NDM5MDhmOGU2OWI5ZWZjZDUwNTExMGIxZTk2ZmQxY2Q2MzM1OWJhMmY#") 提问。
+如果对本手册有任何建议或疑问，请在 [GitHub](https://github.com/vesoft-inc/nebula/issues) 给我们留言。
+
+## 格式约定
+
+**Nebula Graph** 尚在持续开发中，本手册也将持续更新。
+本手册使用如下语法惯例：
+
+- `等宽字体`
+
+    等宽字体用于表示**命令**，**需要用户输入的命令**及**接口**。
+
+- **加粗字体**
+
+    用于命令以及其他需要用户逐字输入的文字。
+
+- `UPPERCASE fixed width`
+
+    在查询语言中，`保留关键字` 和 `非保留关键字` 均使用大写等宽字体表示。
+
+## 文件格式
+
+本手册所有文件均采用 Markdown 编写，HTML 网站使用 [mkdocs](https://www.mkdocs.org/) 自动生成。