Procházet zdrojové kódy

refactor(doc): move overviews to header page

Signed-off-by: Jiyong Huang <huangjy@emqx.io>
Jiyong Huang před 1 rokem
rodič
revize
5bb6ce7f27
1 změnil soubory, kde provedl 30 přidání a 129 odebrání
  1. 30 129
      docs/directory.json

+ 30 - 129
docs/directory.json

@@ -6,12 +6,9 @@
 		},
 		},
 		{
 		{
 			"title": "快速开始",
 			"title": "快速开始",
+			"path": "getting_started/getting_started",
 			"children": [
 			"children": [
 				{
 				{
-					"title": "快速开始",
-					"path": "getting_started/getting_started"
-				},
-				{
 					"title": "5分钟快速运行",
 					"title": "5分钟快速运行",
 					"path": "getting_started/quick_start_docker"
 					"path": "getting_started/quick_start_docker"
 				},
 				},
@@ -23,21 +20,13 @@
 		},
 		},
 		{
 		{
 			"title": "安装与部署",
 			"title": "安装与部署",
-			"children": [
-				{
-					"title": "安装与部署",
-					"path": "installation"
-				}
-			]
+			"path": "installation"
 		},
 		},
 		{
 		{
 			"title": "配置",
 			"title": "配置",
+			"path": "configuration/configuration",
 			"children": [
 			"children": [
 				{
 				{
-					"title": "配置",
-					"path": "configuration/configuration"
-				},
-				{
 					"title": "全局配置文件",
 					"title": "全局配置文件",
 					"path": "configuration/global_configurations"
 					"path": "configuration/global_configurations"
 				}
 				}
@@ -48,21 +37,13 @@
 			"children": [
 			"children": [
 				{
 				{
 					"title": "流:无界的事件系列",
 					"title": "流:无界的事件系列",
-					"children": [
-						{
-							"title": "流",
-							"path": "guide/streams/overview"
-						}
-					]
+					"path": "guide/streams/overview"
 				},
 				},
 				{
 				{
 					"title": "表:事件序列的快照",
 					"title": "表:事件序列的快照",
+					"path": "guide/tables/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "表",
-							"path": "guide/tables/overview"
-						},
-						{
 							"title": "扫描表",
 							"title": "扫描表",
 							"path": "guide/tables/scan"
 							"path": "guide/tables/scan"
 						},
 						},
@@ -74,12 +55,9 @@
 				},
 				},
 				{
 				{
 					"title": "规则:查询和动作",
 					"title": "规则:查询和动作",
+					"path": "guide/rules/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "规则",
-							"path": "guide/rules/overview"
-						},
-						{
 							"title": "图规则",
 							"title": "图规则",
 							"path": "guide/rules/graph_rule"
 							"path": "guide/rules/graph_rule"
 						},
 						},
@@ -95,12 +73,9 @@
 				},
 				},
 				{
 				{
 					"title": "数据源",
 					"title": "数据源",
+					"path": "guide/sources/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "数据源",
-							"path": "guide/sources/overview"
-						},
-						{
 							"title": "内置源",
 							"title": "内置源",
 							"children": [
 							"children": [
 								{
 								{
@@ -162,12 +137,9 @@
 				},
 				},
 				{
 				{
 					"title": "数据汇(Sink)",
 					"title": "数据汇(Sink)",
+					"path": "guide/sinks/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "概览",
-							"path": "guide/sinks/overview"
-						},
-						{
 							"title": "数据模板",
 							"title": "数据模板",
 							"path": "guide/sinks/data_template"
 							"path": "guide/sinks/data_template"
 						},
 						},
@@ -249,12 +221,9 @@
 				},
 				},
 				{
 				{
 					"title": "序列化",
 					"title": "序列化",
+					"path": "guide/serialization/serialization",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "概览",
-							"path": "guide/serialization/serialization"
-						},
-						{
 							"title": "使用 Protobuf 编解码教程",
 							"title": "使用 Protobuf 编解码教程",
 							"path": "guide/serialization/protobuf_tutorial"
 							"path": "guide/serialization/protobuf_tutorial"
 						}
 						}
@@ -308,12 +277,9 @@
 				},
 				},
 				{
 				{
 					"title": "配置",
 					"title": "配置",
+					"path": "configuration/configuration",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "配置",
-							"path": "configuration/configuration"
-						},
-						{
 							"title": "全局配置文件",
 							"title": "全局配置文件",
 							"path": "configuration/global_configurations"
 							"path": "configuration/global_configurations"
 						}
 						}
@@ -485,19 +451,13 @@
 		},
 		},
 		{
 		{
 			"title": "开发者指南",
 			"title": "开发者指南",
+			"path": "extension/overview",
 			"children": [
 			"children": [
 				{
 				{
-					"title": "概览",
-					"path": "extension/overview"
-				},
-				{
 					"title": "原生插件开发",
 					"title": "原生插件开发",
+					"path": "extension/native/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "总览",
-							"path": "extension/native/overview"
-						},
-						{
 							"title": "原生插件开发",
 							"title": "原生插件开发",
 							"path": "extension/native/develop/overview"
 							"path": "extension/native/develop/overview"
 						},
 						},
@@ -568,12 +528,9 @@
 				},
 				},
 				{
 				{
 					"title": "语法",
 					"title": "语法",
+					"path": "sqls/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "概览",
-							"path": "sqls/overview"
-						},
-						{
 							"title": "词汇元素",
 							"title": "词汇元素",
 							"path": "sqls/lexical_elements"
 							"path": "sqls/lexical_elements"
 						},
 						},
@@ -656,12 +613,9 @@
 			"children": [
 			"children": [
 				{
 				{
 					"title": "Rest API 接口",
 					"title": "Rest API 接口",
+					"path": "api/restapi/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "接口介绍",
-							"path": "api/restapi/overview"
-						},
-						{
 							"title": "认证配置",
 							"title": "认证配置",
 							"path": "api/restapi/authentication"
 							"path": "api/restapi/authentication"
 						},
 						},
@@ -709,12 +663,9 @@
 				},
 				},
 				{
 				{
 					"title": "命令行工具",
 					"title": "命令行工具",
+					"path": "api/cli/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "总览",
-							"path": "api/cli/overview"
-						},
-						{
 							"title": "流管理",
 							"title": "流管理",
 							"path": "api/cli/streams"
 							"path": "api/cli/streams"
 						},
 						},
@@ -762,12 +713,9 @@
 		},
 		},
 		{
 		{
 			"title": "Getting Started",
 			"title": "Getting Started",
+			"path": "getting_started/getting_started",
 			"children": [
 			"children": [
 				{
 				{
-					"title": "Getting Started",
-					"path": "getting_started/getting_started"
-				},
-				{
 					"title": "5 Minutes Quick Start",
 					"title": "5 Minutes Quick Start",
 					"path": "getting_started/quick_start_docker"
 					"path": "getting_started/quick_start_docker"
 				},
 				},
@@ -779,21 +727,13 @@
 		},
 		},
 		{
 		{
 			"title": "Installation",
 			"title": "Installation",
-			"children": [
-				{
-					"title": "Installation",
-					"path": "installation"
-				}
-			]
+			"path": "installation"
 		},
 		},
 		{
 		{
 			"title": "Configuration",
 			"title": "Configuration",
+			"path": "configuration/configuration",
 			"children": [
 			"children": [
 				{
 				{
-					"title": "Configuration",
-					"path": "configuration/configuration"
-				},
-				{
 					"title": "Global Configurations",
 					"title": "Global Configurations",
 					"path": "configuration/global_configurations"
 					"path": "configuration/global_configurations"
 				}
 				}
@@ -804,21 +744,13 @@
 			"children": [
 			"children": [
 				{
 				{
 					"title": "Stream: unbounded series of events",
 					"title": "Stream: unbounded series of events",
-					"children": [
-						{
-							"title": "Overview",
-							"path": "guide/streams/overview"
-						}
-					]
+					"path": "guide/streams/overview"
 				},
 				},
 				{
 				{
 					"title": "Table: snapshot of events",
 					"title": "Table: snapshot of events",
+					"path": "guide/tables/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Overview",
-							"path": "guide/tables/overview"
-						},
-						{
 							"title": "Scan Table",
 							"title": "Scan Table",
 							"path": "guide/tables/scan"
 							"path": "guide/tables/scan"
 						},
 						},
@@ -830,12 +762,9 @@
 				},
 				},
 				{
 				{
 					"title": "Rule: query and action",
 					"title": "Rule: query and action",
+					"path": "guide/rules/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Rules",
-							"path": "guide/rules/overview"
-						},
-						{
 							"title": "Graph Rule",
 							"title": "Graph Rule",
 							"path": "guide/rules/graph_rule"
 							"path": "guide/rules/graph_rule"
 						},
 						},
@@ -851,12 +780,9 @@
 				},
 				},
 				{
 				{
 					"title": "Source Connectors",
 					"title": "Source Connectors",
+					"path": "guide/sources/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Overview",
-							"path": "guide/sources/overview"
-						},
-						{
 							"title": "Built-in Sources",
 							"title": "Built-in Sources",
 							"children": [
 							"children": [
 								{
 								{
@@ -918,12 +844,9 @@
 				},
 				},
 				{
 				{
 					"title": "Sink Connectors",
 					"title": "Sink Connectors",
+					"path": "guide/sinks/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Overview",
-							"path": "guide/sinks/overview"
-						},
-						{
 							"title": "Data Template",
 							"title": "Data Template",
 							"path": "guide/sinks/data_template"
 							"path": "guide/sinks/data_template"
 						},
 						},
@@ -1005,13 +928,9 @@
 				},
 				},
 				{
 				{
 					"title": "Serialization",
 					"title": "Serialization",
-
+					"path": "guide/serialization/serialization",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Overview",
-							"path": "guide/serialization/serialization"
-						},
-						{
 							"title": "Protobuf Codec Tutorial",
 							"title": "Protobuf Codec Tutorial",
 							"path": "guide/serialization/protobuf_tutorial"
 							"path": "guide/serialization/protobuf_tutorial"
 						}
 						}
@@ -1065,12 +984,9 @@
 				},
 				},
 				{
 				{
 					"title": "Configuration",
 					"title": "Configuration",
+					"path": "configuration/configuration",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Configuration",
-							"path": "configuration/configuration"
-						},
-						{
 							"title": "Global Configurations",
 							"title": "Global Configurations",
 							"path": "configuration/global_configurations"
 							"path": "configuration/global_configurations"
 						}
 						}
@@ -1242,19 +1158,13 @@
 		},
 		},
 		{
 		{
 			"title": "Developer Guide",
 			"title": "Developer Guide",
+			"path": "extension/overview",
 			"children": [
 			"children": [
 				{
 				{
-					"title": "Introduction",
-					"path": "extension/overview"
-				},
-				{
 					"title": "Native Plugin Develop",
 					"title": "Native Plugin Develop",
+					"path": "extension/native/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Overview",
-							"path": "extension/native/overview"
-						},
-						{
 							"title": "Develop",
 							"title": "Develop",
 							"path": "extension/native/develop/overview"
 							"path": "extension/native/develop/overview"
 						},
 						},
@@ -1325,12 +1235,9 @@
 				},
 				},
 				{
 				{
 					"title": "Syntax",
 					"title": "Syntax",
+					"path": "sqls/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Introduction",
-							"path": "sqls/overview"
-						},
-						{
 							"title": "Lexical elements",
 							"title": "Lexical elements",
 							"path": "sqls/lexical_elements"
 							"path": "sqls/lexical_elements"
 						},
 						},
@@ -1413,12 +1320,9 @@
 			"children": [
 			"children": [
 				{
 				{
 					"title": "Rest API",
 					"title": "Rest API",
+					"path": "api/restapi/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Introduction",
-							"path": "api/restapi/overview"
-						},
-						{
 							"title": "Authentication",
 							"title": "Authentication",
 							"path": "api/restapi/authentication"
 							"path": "api/restapi/authentication"
 						},
 						},
@@ -1466,12 +1370,9 @@
 				},
 				},
 				{
 				{
 					"title": "Command Line Tool",
 					"title": "Command Line Tool",
+					"path": "api/cli/overview",
 					"children": [
 					"children": [
 						{
 						{
-							"title": "Introduction",
-							"path": "api/cli/overview"
-						},
-						{
 							"title": "Streams",
 							"title": "Streams",
 							"path": "api/cli/streams"
 							"path": "api/cli/streams"
 						},
 						},