docs: supplement ceresdb docs (#555)

* add table operation doc * refact docs summary * refactor docs summary * Update docs/guides/src/SUMMARY.md Co-authored-by: WEI Xikai <ShiKaiWi@users.noreply.github.com> * rm Chinese doc * Update docs/guides/src/operation/monitor.md Co-authored-by: WEI Xikai <ShiKaiWi@users.noreply.github.com> * rename observability doc * Update docs/guides/src/SUMMARY.md Co-authored-by: WEI Xikai <ShiKaiWi@users.noreply.github.com> * update summary && update doc path * rename doc of table partitioning * Update docs/guides/src/operation/observability.md Co-authored-by: WEI Xikai <ShiKaiWi@users.noreply.github.com> * rename headline Co-authored-by: WEI Xikai <ShiKaiWi@users.noreply.github.com>
apache · Jan 10, 2023 · 85743ef · 85743ef
1 parent f9bbaad
commit 85743ef
Show file tree

Hide file tree

Showing 19 changed files with 52 additions and 14 deletions.
diff --git a/docs/guides/src/SUMMARY.md b/docs/guides/src/SUMMARY.md
@@ -7,10 +7,10 @@
 
 # User Guide
 
-- [Data Model](model/README.md)
-    - [Data Types](model/data_types.md)
-    - [Special Columns](model/special_columns.md)
 - [SQL Syntax](sql/README.md)
+    - [Data Model](sql/model/README.md)
+        - [Data Types](sql/model/data_types.md)
+        - [Special Columns](sql/model/special_columns.md)
     - [Identifier](sql/identifier.md)
     - [Data Definition Statements](sql/ddl/README.md)
         - [CREATE TABLE](sql/ddl/create_table.md)
@@ -19,18 +19,24 @@
         - [INSERT](sql/dml/insert.md)
         - [SELECT](sql/dml/select.md)
     - [Utility Statements](sql/utility.md)
-- [Analytic Engine](analytic_engine/README.md)
-    - [Options](analytic_engine/options.md)
+    - [Engine Options](sql/engine_options.md)
+
 - [Deployment](deploy/README.md)
     - [Supported Platform](deploy/platform.md)
     - [Static Routing](deploy/static_routing.md)
     - [Dynamic Routing](deploy/dynamic_routing.md)
+
 - [Develop Kits](sdk.md)
-- [Protocol](protocol.md)
+    - [Java SDK](sdk/java.md)
+    - [Go SDK](sdk/go.md)
+    - [Python SDK](sdk/python.md)
+    - [Rust SDK](sdk/rust.md)
+
 - [Operation](operation/README.md)
     - [Table](operation/table.md)
     - [System Table](operation/system_table.md)
     - [Block List](operation/block_list.md)
+    - [Observability](operation/observability.md)
 
 # Dev Guide
 - [Supported Platform](dev/platform.md)
@@ -41,7 +47,8 @@
 
 # Technical and Design
 - [Architecture](architecture.md)
+- [Storage](storage.md)
+- [Query](query.md)
+- [Wal](wal.md)
+- [Table Partitioning](table_partitioning.md)
 
------
-
-- [Trouble Shooting](trouble_shooting.md)
diff --git a/docs/guides/src/about.md b/docs/guides/src/about.md
@@ -16,5 +16,5 @@ The basic design idea of CeresDB is to adopt a hybrid storage format and the cor
 
 # How does CeresDB work?
 - See [Quick Start](quick_start.md) to learn about how to get started
-- For data model of CeresDB, see [Data Model](model)
+- For data model of CeresDB, see [Data Model](sql/model)
 - For the supported SQL data types, operators, and commands, please navigate to [SQL reference](sql)
diff --git a/docs/guides/src/analytic_engine/README.md b/docs/guides/src/analytic_engine/README.md
diff --git a/docs/guides/src/operation/README-cn.md b/docs/guides/src/operation/README-cn.md
@@ -0,0 +1,3 @@
+# 运维手册
+
+本章主要介绍CeresDB系统相关的运维操作，包括集群安装，数据库表操作，容错，灾备，数据导入导出等。
diff --git a/docs/guides/src/operation/observability.md b/docs/guides/src/operation/observability.md
@@ -0,0 +1,6 @@
+# Observability
+
+CeresDB is observable with Prometheus and Grafana.
+
+
+
diff --git a/docs/guides/src/query.md b/docs/guides/src/query.md
@@ -0,0 +1 @@
+# Query
diff --git a/docs/guides/src/quick_start.md b/docs/guides/src/quick_start.md
@@ -82,5 +82,5 @@ See [sdk](./sdk.md)
 ## Next Step
 
 Congrats, you have finished this tutorial. For more information about CeresDB, see the following:
-- [Data Model](./model)
+- [Data Model](sql/model)
 - [Analytic Engine](./analytic_engine)
diff --git a/docs/guides/src/sdk/go.md b/docs/guides/src/sdk/go.md
@@ -0,0 +1,4 @@
+# Go
+
+
+
diff --git a/docs/guides/src/sdk/java.md b/docs/guides/src/sdk/java.md
@@ -0,0 +1,5 @@
+# Java
+
+
+
+
diff --git a/docs/guides/src/sdk/python.md b/docs/guides/src/sdk/python.md
@@ -0,0 +1,5 @@
+# Python
+
+
+
+
diff --git a/docs/guides/src/sdk/rust.md b/docs/guides/src/sdk/rust.md
@@ -0,0 +1,5 @@
+# Rust
+
+
+
+
diff --git a/docs/guides/src/sql/ddl/create_table.md b/docs/guides/src/sql/ddl/create_table.md
@@ -26,7 +26,7 @@ Add `IF NOT EXIST` to tell CeresDB to ignore errors if the table name already ex
 
 ## Define Column
 
-A column's definition should at least contains the name and type parts. All supported types are listed [here](../../model/data_types.md).
+A column's definition should at least contains the name and type parts. All supported types are listed [here](../model/data_types.md).
 
 Column is default be nullable. i.e. `NULL` keyword is implied. Adding `NOT NULL` constrains to make it required.
 ```sql
@@ -39,7 +39,7 @@ a_nullable int NULL
 b_not_null NOT NULL
 ```
 
-A column can be marked as [special column](../../model/special_columns.md) with related keyword.
+A column can be marked as [special column](../model/special_columns.md) with related keyword.
 
 ## Engine
 

diff --git a/docs/guides/src/analytic_engine/options.md → docs/guides/src/sql/engine_options.md b/docs/guides/src/analytic_engine/options.md → docs/guides/src/sql/engine_options.md
diff --git a/docs/guides/src/model/README.md → docs/guides/src/sql/model/README.md b/docs/guides/src/model/README.md → docs/guides/src/sql/model/README.md
diff --git a/docs/guides/src/model/data_types.md → docs/guides/src/sql/model/data_types.md b/docs/guides/src/model/data_types.md → docs/guides/src/sql/model/data_types.md
diff --git a/docs/guides/src/model/special_columns.md → docs/guides/src/sql/model/special_columns.md b/docs/guides/src/model/special_columns.md → docs/guides/src/sql/model/special_columns.md
diff --git a/docs/guides/src/storage.md b/docs/guides/src/storage.md
@@ -0,0 +1 @@
+# Storage
diff --git a/docs/guides/src/table_partitioning.md b/docs/guides/src/table_partitioning.md
@@ -0,0 +1 @@
+# Table Partitioning
diff --git a/docs/guides/src/wal.md b/docs/guides/src/wal.md
@@ -0,0 +1 @@
+# Wal