Merge remote-tracking branch 'github/master' into extension

README.md

@@ -12,11 +12,11 @@ A SQL based lightweight IoT analytics/streaming software running at resource con
 ## Document
 English
 - [Getting started](docs/en_US/getting_started.md) 
-- [Reference guide](docs/en_US/index.md) 
+- [Reference guide](docs/en_US/reference.md) 
 
 中文
 - [入门教程](docs/zh_CN/getting_started.md) 
-- [参考指南](docs/zh_CN/index.md)
+- [参考指南](docs/zh_CN/reference.md)
 
 ## Build from source code
 

docs/.gitignore

@@ -0,0 +1 @@
+.lock

docs/en_US/README.md

@@ -0,0 +1,54 @@
+# A lightweight IoT edge analytic software
+
+## Highlight
+
+A SQL based lightweight IoT analytics/streaming software running at resource constrained edge devices.
+- Native run with small overhead ( ~7MB package), support Linux/Windows/Mac OS
+- SQL based, easy to use
+- Built-in support for MQTT source
+- Extension - user can customize the rule engine
+- RESTful APIs for rules management
+
+## Document
+English
+- [Getting started](./getting_started.md) 
+- [Reference guide](./reference.md) 
+
+中文
+- [入门教程](https://docs.emqx.io/kuiper/cn/getting_started.html) 
+- [参考指南](https://docs.emqx.io/kuiper/cn/reference.html)
+
+## Build from source code
+
+#### Prepare
+
++ Go version >= 1.11
+
+#### Build binary file
+
++ Build binary file
+
+  ```shell
+  $ make
+  ```
+
++ Cross build binary file
+
+  ```shell
+  $ GOOS=linux GOARCH=arm make 
+  ```
+
+#### Get the compressed file
+
++ Get the compressed files
+ 
+  ```
+  $ make pkg
+  ```
+
++ Get the cross-build compressed file
+
+  ```
+  $ GOOS=linux GOARCH=arm make pkg
+  ```
+  

docs/en_US/SUMMARY.md

@@ -1,9 +1,26 @@
-- [Introduction](./README.md)
-- [Getting started](./getting_started.md)
+- [Introduction](README.md)
+- [Getting started](getting_started.md)
 
-- [Reference Guide](./reference.md)
-  - [Install and operation](operation/overview.md)
-  - [Command line interface tools - CLI](cli/overview.md)
-  - [Kuiper SQL reference](sqls/overview.md)
-  - [Rules](rules/overview.md)
-  - [Extend Kuiper](extension/overview.md)
+## Reference Guide
+- [Reference Guide](reference.md)
+- [Install and operation](operation/overview.md)
+  - [Install instruction](operation/install/overview.md)
+  - [Cent-OS](operation/install/cent-os.md)
+  - [Operation guide](operation/operations.md)
+  - [Kuiper basic configuration](operation/configuration_file.md)
+  - [MQTT source configuration](rules/sources/mqtt.md)
+- [Command line interface tools - CLI](cli/overview.md)
+  - [Streams](cli/streams.md)
+  - [Rules](cli/rules.md)
+- [Kuiper SQL reference](sqls/overview.md)
+  - [Stream specifications](sqls/streams.md)
+  - [Query languange element](sqls/query_language_elements.md)
+  - [Windows](sqls/windows.md)
+  - [Built-in functions](sqls/built-in_functions.md)
+- [Rules](rules/overview.md)
+  - [Log action](rules/sinks/logs.md)
+  - [MQTT action](rules/sinks/mqtt.md)
+- [Extend Kuiper](extension/overview.md)
+  <!-- - [Source extension]()
+  - [Sink/Action extension]()
+  - [Functions extension]() -->

docs/package.json

@@ -7,13 +7,10 @@
   "license": "Apache 2.0",
   "private": true,
   "scripts": {
-    "build:before": "cp ../README.md en_US/ && mv zh_CN/index.md zh_CN/README.md && mv en_US/index.md en_US/reference.md",
-    "build:after": "mv zh_CN/README.md zh_CN/index.md && rm -rf en_US/README.md && mv en_US/reference.md en_US/index.md",
-    "serve": "npm run build:before && gitbook serve",
-    "reset": "npm run build:after",
-    "docs": "npm run build:before && gitbook install && gitbook serve",
-    "html": "npm run build:before && gitbook install && gitbook build . _book && npm run build:after",
-    "pdf": "npm run build:before && gitbook install && gitbook pdf . _book.pdf && npm run build:after"
+    "serve": "gitbook serve",
+    "docs": "gitbook install && gitbook serve",
+    "html": "gitbook install && gitbook build . _book",
+    "pdf": "gitbook install && gitbook pdf . _book.pdf"
   },
   "dependencies": {
     "gitbook-cli": "^2.3.2"

docs/zh_CN/README.md

@@ -0,0 +1,54 @@
+# A lightweight IoT edge analytic software
+
+## Highlight
+
+A SQL based lightweight IoT analytics/streaming software running at resource constrained edge devices.
+- Native run with small overhead ( ~7MB package), support Linux/Windows/Mac OS
+- SQL based, easy to use
+- Built-in support for MQTT source
+- Extension - user can customize the rule engine
+- RESTful APIs for rules management
+
+## Document
+English
+- [Getting started](https://docs.emqx.io/kuiper/en/getting_started.html) 
+- [Reference guide](https://docs.emqx.io/kuiper/en/reference.html) 
+
+中文
+- [入门教程](./getting_started.md) 
+- [参考指南](./index.md)
+
+## Build from source code
+
+#### Prepare
+
++ Go version >= 1.11
+
+#### Build binary file
+
++ Build binary file
+
+  ```shell
+  $ make
+  ```
+
++ Cross build binary file
+
+  ```shell
+  $ GOOS=linux GOARCH=arm make 
+  ```
+
+#### Get the compressed file
+
++ Get the compressed files
+ 
+  ```
+  $ make pkg
+  ```
+
++ Get the cross-build compressed file
+
+  ```
+  $ GOOS=linux GOARCH=arm make pkg
+  ```
+  

docs/zh_CN/SUMMARY.md

@@ -1,5 +1,23 @@
+- [Introduction](README.md)
+- [快速入门](getting_started.md)
+
+## 参考指南
+- [参考指南](reference.md)
 - [安装与操作](operation/overview.md)
+  - [安装说明](operation/install/overview.md)
+  - [Cent-OS](operation/install/cent-os.md)
+  - [操作指南](operation/operations.md)
+  - [Kuiper 基本配置](operation/configuration_file.md)
+  - [MQTT 源配置](rules/sources/mqtt.md)
 - [命令行界面工具-CLI](cli/overview.md)
-- [Kuiper SQL参考](sqls/overview.md)
+  - [流管理](cli/streams.md)
+  - [规则管理](cli/rules.md)
+- [Kuiper SQL 参考](sqls/overview.md)
+  - [流规格](sqls/streams.md)
+  - [查询语言元素](sqls/query_language_elements.md)
+  - [窗口](sqls/windows.md)
+  - [函数](sqls/built-in_functions.md)
 - [规则](rules/overview.md)
-- [扩展Kuiper](extension/overview.md)
+  - [日志动作](rules/sinks/logs.md)
+  - [MQTT 动作](rules/sinks/mqtt.md)
+- [扩展 Kuiper](extension/overview.md)