the quick start demos in SDK documents

GreptimeTeam · Sep 5, 2024 · 00074ef · 00074ef
1 parent 246ddc2
commit 00074ef
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 34 deletions.
diff --git a/docs/user-guide/ingest-data/for-iot/grpc-sdks/go.md b/docs/user-guide/ingest-data/for-iot/grpc-sdks/go.md
@@ -11,6 +11,11 @@ concurrent-safe library that is easy to use with the metric struct.
 
 </div>
 
+<div id="quick-start-demos">
+
+To quickly get started, you can explore the [quick start demos](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples) to understand how to use the GreptimeDB Go ingester SDK.
+
+</div>
 
 <div id="ingester-lib-installation">
 
@@ -212,12 +217,6 @@ affected, err := cli.CloseStream(ctx)
 
 </div>
 
-<div id="more-ingestion-examples">
-
-For fully runnable code snippets and explanations for common methods, see the [Examples](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples).
-
-</div>
-
 <div id="ingester-lib-reference">
 
 - [API Documentation](https://pkg.go.dev/github.com/GreptimeTeam/greptimedb-ingester-go)

diff --git a/docs/user-guide/ingest-data/for-iot/grpc-sdks/java.md b/docs/user-guide/ingest-data/for-iot/grpc-sdks/java.md
@@ -15,6 +15,12 @@ The Java ingester SDK provided by GreptimeDB is a lightweight library with the f
 
 </div>
 
+<div id="quick-start-demos">
+
+To quickly get started, you can explore the [quick start demos](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime) to understand how to use the GreptimeDB Java ingester SDK.
+
+</div>
+
 <div id="ingester-lib-installation">
 
 1. Install the Java Development Kit(JDK)
@@ -300,19 +306,13 @@ LOG.info("Write result: {}", result);
 
 <div id="ingester-lib-debug-logs">
 
-### Debug logs
+## Debug logs
 
 The ingester SDK provides metrics and logs for debugging.
 Please refer to [Metrics & Display](https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/main/docs/metrics-display.md) and [Magic Tools](https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/main/docs/magic-tools.md) to learn how to enable or disable the logs.
 
 </div>
 
-<div id="more-ingestion-examples">
-
-For fully runnable code snippets and the complete code of the demo, please refer to the [Examples](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime).
-
-</div>
-
 <div id="ingester-lib-reference">
 
 - [API Documentation](https://javadoc.io/doc/io.greptime/ingester-protocol/latest/index.html)

diff --git a/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md b/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md
@@ -6,6 +6,10 @@ For more information, refer to [Automatic Schema Generation](/user-guide/ingest-
 
 <InjectContent id="ingester-lib-introduction" content={props.children}/>
 
+## Quick start demos
+
+<InjectContent id="quick-start-demos" content={props.children}/>
+
 ## Installation
 
 <InjectContent id="ingester-lib-installation" content={props.children}/>
@@ -84,10 +88,6 @@ Streaming insert is useful when you want to insert a large amount of data such a
 
 <InjectContent id="high-level-style-update-data" content={props.children}/>
 
-## More examples
-
-<InjectContent id="more-ingestion-examples" content={props.children}/>
-
 <InjectContent id="ingester-lib-debug-logs" content={props.children}/>
 
 ## Ingester library reference

diff --git a/...urus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/go.md b/...urus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/go.md
@@ -10,6 +10,11 @@ GreptimeDB 提供的 Go Ingest SDK 是一个轻量级、并发安全的库，使
 
 </div>
 
+<div id="quick-start-demos">
+
+你可以通过[快速开始 Demo](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples) 来了解如何使用 GreptimeDB Go SDK。
+
+</div>
 
 <div id="ingester-lib-installation">
 
@@ -189,12 +194,6 @@ affected, err := cli.CloseStream(ctx)
 
 </div>
 
-<div id="more-ingestion-examples">
-
-有关更多可运行的代码片段和常用方法的解释，请参阅[示例](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples)。
-
-</div>
-
 <div id="ingester-lib-reference">
 
 - [API 文档](https://pkg.go.dev/github.com/GreptimeTeam/greptimedb-ingester-go)

diff --git a/...us-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/java.md b/...us-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/java.md
@@ -15,6 +15,12 @@ GreptimeDB 提供的 Java ingester SDK 是一个轻量级库，具有以下特
 
 </div>
 
+<div id="quick-start-demos">
+
+你可以通过[快速开始 Demo](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime) 来了解如何使用 GreptimeDB Java SDK。
+
+</div>
+
 <div id="ingester-lib-installation">
 
 1. 安装 Java 开发工具包（JDK）
@@ -294,17 +300,11 @@ LOG.info("Write result: {}", result);
 
 ## 调试日志
 
-ingester SDK 提供了用于调试的指标和日志。
+Java SDK 提供了用于调试的指标和日志。
 请参考 [Metrics & Display](https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/main/docs/metrics-display.md) 和 [Magic Tools](https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/main/docs/magic-tools.md) 了解如何启用或禁用日志。
 
 </div>
 
-<div id="more-ingestion-examples">
-
-请参考[示例](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime)获取更多完全可运行的代码片段和常用方法的解释。
-
-</div>
-
 <div id="ingester-lib-reference">
 
 - [API 文档](https://javadoc.io/doc/io.greptime/ingester-protocol/latest/index.html)

diff --git a/...lugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md b/...lugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md
@@ -5,6 +5,10 @@ GreptimeDB 提供了用于高吞吐量数据写入的 ingester 库。
 
 <InjectContent id="ingester-lib-introduction" content={props.children}/>
 
+## 快速开始 Demo
+
+<InjectContent id="quick-start-demos" content={props.children}/>
+
 ## 安装
 
 <InjectContent id="ingester-lib-installation" content={props.children}/>
@@ -82,10 +86,6 @@ SDK 的高层级 API 使用 ORM 风格的对象写入数据，
 
 <InjectContent id="high-level-style-update-data" content={props.children}/>
 
-## 更多示例
-
-<InjectContent id="more-ingestion-examples" content={props.children}/>
-
 <InjectContent id="ingester-lib-debug-logs" content={props.children}/>
 
 ## Ingester 库参考