ekuiper-new/docs/directory.json

{
	"cn": [
		{
			"title": "概要",
			"path": "./"
		},
		{
			"title": "安装试用",
			"children": [{
					"title": "下载安装快速入门",
					"path": "getting_started"
				},
				{
					"title": "Docker 容器安装教程",
					"path": "quick_start_docker"
				},
				{
					"title": "EdgeX Foundry 规则引擎教程",
					"path": "edgex/edgex_rule_engine_tutorial"
				},
				{
					"title": "如何使用 meta 函数抽取在 EdgeX 消息总线中发送的其它信息",
					"path": "edgex/edgex_meta"
				}
			]
		},
		{
			"title": "规则",
			"children": [{
					"title": "规则管理",
					"path": "rules/overview"
				},
				{
				"title": "规则流水线",
				"path": "rules/rule_pipeline"
				},
				{
					"title": "Sinks 动作",
					"children": [{
							"title": "EdgeX 消息总线目标",
							"path": "rules/sinks/edgex"
						},
						{
							"title": "MQTT 动作",
							"path": "rules/sinks/mqtt"
						},
						{
							"title": "Nop 动作",
							"path": "rules/sinks/nop"
						},
						{
							"title": "REST动作",
							"path": "rules/sinks/rest"
						},
						{
							"title": "日志操作",
							"path": "rules/sinks/log"
						},
						{
							"title": "内存动作",
							"path": "rules/sinks/memory"
						}
					]
				},
				{
					"title": "Sources 源",
					"children": [{
							"title": "EdgeX 源",
							"path": "rules/sources/edgex"
						},
						{
							"title": "HTTP 提取源",
							"path": "rules/sources/http_pull"
						},
						{
							"title": "MQTT源",
							"path": "rules/sources/mqtt"
						},
						{
							"title": "文件源",
							"path": "rules/sources/file"
						},
						{
							"title": "内存源",
							"path": "rules/sources/memory"
						}
					]
				},
				{
					"title": "Golang 模版",
					"path": "rules/data_template"
				},
				{
					"title": "状态和容错",
					"path": "rules/state_and_fault_tolerance"
				}

			]
		},

		{
			"title": "eKuiper SQL 参考",
			"children": [
				{
					"title": "eKuiper SQL 介绍",
					"path": "sqls/overview"
				},
				{
					"title": "流规格",
					"path": "sqls/streams"
				},
				{
					"title": "表规格",
					"path": "sqls/tables"
				},
				{
					"title": "查询语言元素",
					"path": "sqls/query_language_elements"
				},
				{
					"title": "窗口",
					"path": "sqls/windows"
				},
				{
					"title": "函数",
					"path": "sqls/built-in_functions"
				},
				{
					"title": "数据类型",
					"path": "sqls/data_types"
				},
				{
					"title": "eKuiper 词汇元素",
					"path": "sqls/lexical_elements"
				},
				{
					"title": "JSON 表达式",
					"path": "sqls/json_expr"
				}
			]
		},
		{
			"title": "扩展 eKuiper",
			"children": [{
					"title": "扩展概要",
					"path": "extension/overview"
				},
				{
					"title": "调用外部函数",
					"path": "extension/external/external_func"

				},
				{
					"title": "原生插件开发",
					"children": [
						{
							"title": "原生插件概要",
							"path": "extension/native/overview"
						},
						{
							"title": "自定义原生插件开发",
							"children": [
								{
									"title": "插件开发介绍",
									"path": "extension/native/develop/overview"
								},
								{
									"title": "插件开发教程",
									"path": "extension/native/develop/plugins_tutorial"
								},
								{
									"title": "函数插件开发",
									"path": "extension/native/develop/function"
								},
								{
									"title": "目标插件开发",
									"path": "extension/native/develop/sink"
								},
								{
									"title": "源插件开发",
									"path": "extension/native/develop/source"
								}
							]
						},
						{
							"title": "预定义的目标扩展",
							"children": [
								{
											"title": "文件目标（Sink）",
											"path": "extension/native/sinks/file"
										},
								{
											"title": "图像目标（Sink）",
											"path": "extension/native/sinks/image"
										},
								{
											"title": "InfluxDB 目标（Sink）",
											"path": "extension/native/sinks/influx"
										},
								{
											"title": "redis 目标（Sink）",
											"path": "extension/native/sinks/redis"
										},
								{
											"title": "TDengine 目标（Sink）",
											"path": "extension/native/sinks/tdengine"
										},
								{
											"title": "Zmq 目标（Sink）",
											"path": "extension/native/sinks/zmq"
										}
							]
						},
						{
									"title": "预定义的源扩展",
									"children": [{
										"title": "random 源（Source）",
										"path": "extension/native/sources/random"
									},
										{
											"title": "Zmq 源（Source）",
											"path": "extension/native/sources/zmq"
										}
									]
								},
						{
									"title": "预定义的函数扩展",
									"path": "extension/native/functions/functions"
								}
					]
				},

				{
					"title": "Portable 插件开发",
					"children": [
						{
							"title": "Portable 插件简介",
							"path": "extension/portable/overview"
						},
						{
							"title": "Portable 插件 Go 语言 SDK",
							"path": "extension/portable/go_sdk"
						},
						{
							"title": "Portable 插件 Python 语言 SDK",
							"path": "extension/portable/python_sdk"
						}
					]
				}
			]
		},

		{
			"title": "使用指南",
			"children": [
				{
					"title": "安装",
					"path": "operation/install/overview"
				},
				{
					"title": "centos 安装",
					"path": "operation/install/cent-os"
				},
				{
					"title": "配置文件",
					"path": "operation/config/configuration_file"
				},
				{
					"title": "认证配置",
					"path": "operation/config/authentication"
				},
				{
					"title": "命令行工具",
					"children": [
						{
							"title": "摘要",
							"path": "operation/cli/overview"
						},
						{
							"title": "流管理",
							"path": "operation/cli/streams"
						},
						{
							"title": "规则管理",
							"path": "operation/cli/rules"
						},
						{
							"title": "表管理",
							"path": "operation/cli/tables"
						},
						{
							"title": "插件管理",
							"path": "operation/cli/plugins"
						}
					]
				},
				{
					"title": "管理控制台",
					"children": [
						{
							"title": "控制台使用",
							"path": "operation/manager-ui/overview"
						},
						{
							"title": "如何将自定义的插件展示在管理控制台的安装列表",
							"path": "operation/manager-ui/plugins_in_manager"
						}
					]
				},
				{
					"title": "Rest API 接口",
					"children": [
						{
							"title": "接口介绍",
							"path": "operation/restapi/overview"
						},
						{
							"title": "流管理",
							"path": "operation/restapi/streams"
						},
						{
							"title": "表管理",
							"path": "operation/restapi/tables"
						},
						{
							"title": "规则管理",
							"path": "operation/restapi/rules"
						},
						{
							"title": "插件管理",
							"path": "operation/restapi/plugins"
						},
						{
							"title": "外部函数管理",
							"path": "operation/restapi/services"
						}
					]
				},
				{
					"title": "交叉编译",
					"path": "operation/compile/cross-compile"
				}
			]
		}
	],
	"en": [
		{
			"title": "Home",
			"path": "reference"
		},
		{
			"title": "Getting Started",
			"children": [
				{
					"title": "Run eKuiper locally",
					"path": "getting_started"
				},
				{
					"title": "Run eKuiper in Docker",
					"path": "quick_start_docker"
				},
				{
					"title": "Run eKuiper with EdgeX Foundry",
					"path": "edgex/edgex_rule_engine_tutorial"
				}
			]
		},
		{
			"title": "Concepts",
			"children": [
				{
					"title": "Why eKuiper",
					"path": "concepts/ekuiper"
				},
				{
					"title": "Rules",
					"path": "concepts/rules"
				},
				{
					"title": "Sources",
					"children": [
						{
							"title": "Overview",
							"path": "concepts/sources/overview"
						},
						{
							"title": "Stream",
							"path": "concepts/sources/stream"
						},
						{
							"title": "Table",
							"path": "concepts/sources/table"
						}
					]
				},
				{
					"title": "Sinks",
					"path": "concepts/sinks"
				},
				{
					"title": "SQL Queries",
					"path": "concepts/sql"
				},
				{
					"title": "Stream Processing",
					"children": [
						{
							"title": "Overview",
							"path": "concepts/streaming/overview"
						},
						{
							"title": "Time Attribute",
							"path": "concepts/streaming/time"
						},
						{
							"title": "Windowing",
							"path": "concepts/streaming/windowing"
						},
						{
							"title": "Join",
							"path": "concepts/streaming/join"
						}
					]
				},
				{
					"title": "Extensions",
					"path": "concepts/extensions"
				}
			]
		},
		{
			"title": "Tutorials",
			"children": [
				{
					"title": "AI",
					"children": [
						{
							"title": "Label image by tensorflow lite model with eKuiper native plugin",
							"path": "tutorials/ai/tensorflow_lite_tutorial"
						}
					]
				},
				{
					"title": "Working with EdgeX Foundry",
					"children": [
						{
							"title": "EdgeX Foundry rule engine tutorial",
							"path": "edgex/edgex_rule_engine_tutorial"
						},
						{
							"title": "Meta function for EdgeX stream",
							"path": "edgex/edgex_meta"
						},
						{
							"title": "Command device with EdgeX eKuiper rules enginem",
							"path": "edgex/edgex_rule_engine_command"
						},
						{
							"title": "EdgeX source configuration command",
							"path": "edgex/edgex_source_tutorial"
						}
					]
				},
				{
					"title": "Deploy by OpenYurt",
					"path": "tutorials/deploy/openyurt_tutorial"
				}
			]
		},
		{
			"title": "References",
			"children": [
				{
					"title": "Rules",
					"children": [
						{
							"title": "Introduction",
							"path": "rules/overview"
						},
						{
							"title": "Rule Pipeline",
							"path": "rules/rule_pipeline"
						},
						{
							"title": "State and Fault Tolerance",
							"path": "rules/state_and_fault_tolerance"
						}
					]
				},
				{
					"title": "Sources",
					"children": [
						{
							"title": "Overview",
							"path": "rules/sources/overview"
						},
						{
							"title": "Built-in sources",
							"children": [
								{
									"title": "MQTT source",
									"path": "rules/sources/builtin/mqtt"
								},
								{
									"title": "EdgeX Source",
									"path": "rules/sources/builtin/edgex"
								},
								{
									"title": "HTTP pull source",
									"path": "rules/sources/builtin/http_pull"
								},
								{
									"title": "Memory source",
									"path": "rules/sources/builtin/memory"
								},
								{
									"title": "File source",
									"path": "rules/sources/builtin/file"
								}
							]
						},
						{
							"title": "Predefined source plugins",
							"children": [
								{
									"title": "Zmq source",
									"path": "rules/sources/plugin/zmq"
								},
								{
									"title": "Random source",
									"path": "rules/sources/plugin/random"
								}
							]
						}
					]
				},
				{
					"title": "Sinks",
					"children": [
						{
							"title": "Overview",
							"path": "rules/sinks/overview"
						},
						{
							"title": "Data Template",
							"path": "rules/data_template"
						},
						{
							"title": "Built-in sinks",
							"children": [
								{
									"title": "MQTT action",
									"path": "rules/sinks/builtin/mqtt"
								},
								{
									"title": "EdgeX Message Bus action",
									"path": "rules/sinks/builtin/edgex"
								},
								{
									"title": "REST action",
									"path": "rules/sinks/builtin/rest"
								},
								{
									"title": "Memory action",
									"path": "rules/sinks/builtin/memory"
								},
								{
									"title": "Log action",
									"path": "rules/sinks/builtin/log"
								},
								{
									"title": "Nop action",
									"path": "rules/sinks/builtin/nop"
								}
							]
						},
						{
							"title": "Predefined sink plugins",
							"children": [
								{
									"title": "Zmq sink",
									"path": "rules/sinks/plugin/zmq"
								},
								{
									"title": "File sink",
									"path": "rules/sinks/plugin/file"
								},
								{
									"title": "InfluxDB sink",
									"path": "rules/sinks/plugin/influx"
								},
								{
									"title": "TDengine sink",
									"path": "rules/sinks/plugin/tdengine"
								},
								{
									"title": "Redis sink",
									"path": "rules/sinks/plugin/redis"
								},
								{
									"title": "Image sink",
									"path": "rules/sinks/plugin/image"
								}
							]
						}
					]
				},
				{
					"title": "SQL",
					"children": [
						{
							"title": "Syntax",
							"children": [
								{
									"title": "Introduction",
									"path": "sqls/overview"
								},
								{
									"title": "Lexical elements",
									"path": "sqls/lexical_elements"
								},
								{
									"title": "Data types",
									"path": "sqls/data_types"
								},
								{
									"title": "JSON Expressions",
									"path": "sqls/json_expr"
								},
								{
									"title": "Query language element",
									"path": "sqls/query_language_elements"
								}
							]
						},
						{
							"title": "Statements",
							"children": [
								{
									"title": "Streams",
									"path": "sqls/streams"
								},
								{
									"title": "Tables",
									"path": "sqls/tables"
								}
							]
						},
						{
							"title": "Windows",
							"path": "sqls/windows"
						},
						{
							"title": "Built-in Functions",
							"path": "sqls/built-in_functions"
						},
						{
							"title": "Predefined function plugins",
							"path": "sqls/custom_functions"
						}
					]
				}
			]
		},
		{
			"title": "Extension Programming",
			"children": [
				{
					"title": "Introduction",
					"path": "extension/overview"
				},
				{
					"title": "Native plugin develop",
					"children": [
						{
							"title": "Native plugin develop overview",
							"path": "extension/native/overview"
						},
						{
							"title": "Custom native plugin develop",
							"children": [
								{
									"title": "Plugin develop introduction",
									"path": "extension/native/develop/overview"
								},
								{
									"title": "Plugin develop tutorial",
									"path": "extension/native/develop/plugins_tutorial"
								},
								{
									"title": "Function plugin",
									"path": "extension/native/develop/function"
								},
								{
									"title": "Sink plugin",
									"path": "extension/native/develop/sink"
								},
								{
									"title": "Source plugin",
									"path": "extension/native/develop/source"
								}
							]
						}
					]
				},
				{
					"title": "Portable plugin develop",
					"children": [
						{
							"title": "Portable Plugin",
							"path": "extension/portable/overview"
						},
						{
							"title": "GO SDK for Portable Plugin",
							"path": "extension/portable/go_sdk"
						},
						{
							"title": "Python SDK for Portable Plugin",
							"path": "extension/portable/python_sdk"
						}
					]
				},
				{
					"title": "External function",
					"path": "extension/external/external_func"
				}
			]
		},
		{
			"title": "Operations",
			"children": [
				{
					"title": "Introduction",
					"path": "operation/overview"
				},
				{
					"title": "Install",
					"children": [
						{
							"title": "overview",
							"path": "operation/install/overview"
						},
						{
							"title": "centos",
							"path": "operation/install/cent-os"
						}
					]
				},
				{
					"title": "Configuration",
					"children": [
						{
							"title": "Configuration File",
							"path": "operation/config/configuration_file"
						},
						{
							"title": "Authentication",
							"path": "operation/config/authentication"
						}
					]
				},
				{
					"title": "Rest API",
					"children": [{
						"title": "Introduction",
						"path": "operation/restapi/overview"
					},
						{
							"title": "Streams",
							"path": "operation/restapi/streams"
						},
						{
							"title": "Tables",
							"path": "operation/restapi/tables"
						},
						{
							"title": "Rules",
							"path": "operation/restapi/rules"
						},
						{
							"title": "Plugins",
							"path": "operation/restapi/plugins"
						},
						{
							"title": "External Services",
							"path": "operation/restapi/services"
						}
					]
				},
				{
					"title": "Command line tool",
					"children": [{
						"title": "Introduction",
						"path": "operation/cli/overview"
					},
						{
							"title": "Streams",
							"path": "operation/cli/streams"
						},
						{
							"title": "Rules",
							"path": "operation/cli/rules"
						},
						{
							"title": "Tables",
							"path": "operation/cli/tables"
						},
						{
							"title": "Plugins",
							"path": "operation/cli/plugins"
						}
					]
				},
				{
					"title": "Management console",
					"children": [
						{
							"title": "Introduction",
							"path": "operation/manager-ui/overview"
						},
						{
							"title": "How to display custom plugins in the installation list of the management console",
							"path": "operation/manager-ui/plugins_in_manager"
						}
					]
				},
				{
					"title": "Compile",
					"children": [
						{
							"title": "Compile",
							"path": "operation/compile/compile"
						},
						{
							"title": "Cross Compile",
							"path": "operation/compile/cross-compile"
						}
					]
				}
			]
		},
		{
			"title": "Contribute",
			"path": "CONTRIBUTING"
		}
	]
}