docs: fix deadlink and some typos in sdk doc (GreptimeTeam#610)

niebayes · Oct 11, 2023 · 6d96f25 · 6d96f25
1 parent 3b40b92
commit 6d96f25
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 14 deletions.
diff --git a/docs/en/v0.4/reference/sdk/go.md b/docs/en/v0.4/reference/sdk/go.md
@@ -11,8 +11,8 @@ A Go Client for GreptimeDB, which is compatible with GreptimeDB protocol and lig
 
 ## How to use
 
-Please refer to User Guide chapter to learn [how to insall SDK](/en/v0.4/user-guide/clients/sdk-libraries/go.md),
-[write data](/en/v0.4/user-guide/write-data/sdk-libraries/go.md) and [query data](/en/v0.4/user-guide/query-data/sdk-libraries/go.md).
+Please refer to User Guide chapter to learn [how to install SDK](../../user-guide/clients/sdk-libraries/go.md),
+[write data](../../user-guide/write-data/sdk-libraries/go.md) and [query data](../../user-guide/query-data/sdk-libraries/go.md).
 
 ## Configuration
 

diff --git a/docs/en/v0.4/reference/sdk/java.md b/docs/en/v0.4/reference/sdk/java.md
@@ -14,17 +14,17 @@ A Java Client for GreptimeDB, which is compatible with GreptimeDB protocol and l
 
 ## How to use
 
-Please refer to User Guide chapter to learn [how to insall SDK](/en/v0.4/user-guide/clients/sdk-libraries/java.md), [write data](/en/v0.4/user-guide/write-data/sdk-libraries/java.md) and [query data](/en/v0.4/user-guide/query-data/sdk-libraries/java.md).
+Please refer to User Guide chapter to learn [how to install SDK](../../user-guide/clients/sdk-libraries/java.md), [write data](../../user-guide/write-data/sdk-libraries/java.md) and [query data](../../user-guide/query-data/sdk-libraries/java.md).
 
 ## Global Options (System properties / Java -Dxxx)
 
 | Name                               | Description                                                                                                                                                        |
-| :--------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
+| :--------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | greptimedb.use_os_signal           | Whether or not to use OS Signal, SDK listens for SIGUSR2 signals by default and can outputs some information. This is helpful when troubleshooting complex issues. |
 | greptimedb.signal.out_dir          | Signal handler can output to the specified directory, default is the process start directory.                                                                      |
 | greptimedb.available_cpus          | Specify the number of available cpus, the default is to use the full number of cpus of the current environment.                                                    |
 | greptimedb.reporter.period_minutes | Metrics reporter timed output period, default 30 minutes.                                                                                                          |
-| greptimedb.read.write.rw_logging   | Whether to print logs for each read/write operation, default off.                                                                                                  |     |
+| greptimedb.read.write.rw_logging   | Whether to print logs for each read/write operation, default off.                                                                                                  |
 
 ## Metrics&Display
 

diff --git a/docs/en/v0.4/user-guide/clients/sdk-libraries/go.md b/docs/en/v0.4/user-guide/clients/sdk-libraries/go.md
@@ -39,7 +39,7 @@ func InitClient() *greptime.Client {
 }
 ```
 
-See [Go SDK in reference](/en/v0.4/reference/sdk/go.md) to get more configurations.
+See [Go SDK in reference](../../../reference/sdk/go.md) to get more configurations.
 
 ## Write Data
 

diff --git a/docs/en/v0.4/user-guide/clients/sdk-libraries/java.md b/docs/en/v0.4/user-guide/clients/sdk-libraries/java.md
@@ -86,7 +86,7 @@ public class QuickStart {
 }
 ```
 
-See [Java SDK in reference](/en/v0.4/reference/sdk/java.md) to get more configurations and metrics.
+See [Java SDK in reference](../../../reference/sdk/java.md) to get more configurations and metrics.
 
 ## Write Data
 

diff --git a/docs/zh/v0.4/reference/sdk/go.md b/docs/zh/v0.4/reference/sdk/go.md
@@ -11,8 +11,8 @@
 
 ## 如何使用
 
-请参考用户指南章节学习 [如何安装 SDK](/zh/v0.4/user-guide/clients/sdk-libraries/go.md)、
-[如何写入数据](/zh/v0.4/user-guide/write-data/sdk-libraries/go.md) 和 [如何查询数据](/zh/v0.4/user-guide/query-data/sdk-libraries/go.md)。
+请参考用户指南章节学习 [如何安装 SDK](../../user-guide/clients/sdk-libraries/go.md)、
+[如何写入数据](../../user-guide/write-data/sdk-libraries/go.md) 和 [如何查询数据](../../user-guide/query-data/sdk-libraries/go.md)。
 
 ## 配置
 

diff --git a/docs/zh/v0.4/reference/sdk/java.md b/docs/zh/v0.4/reference/sdk/java.md
@@ -11,17 +11,17 @@
 
 ## 如何使用
 
-请参考用户指南章节，了解如何 [安装 SDK](/zh/v0.4/user-guide/clients/sdk-libraries/java.md), [写入数据](/zh/v0.4/user-guide/write-data/sdk-libraries/java.md)和[查询数据](/zh/v0.4/user-guide/query-data/sdk-libraries/java.md)。
+请参考用户指南章节，了解如何 [安装 SDK](../../user-guide/clients/sdk-libraries/java.md), [写入数据](../../user-guide/write-data/sdk-libraries/java.md)和[查询数据](../../user-guide/query-data/sdk-libraries/java.md)。
 
 ## 全局配置 (System properties / Java -Dxxx)
 
 | 属性                               | 描述                                                                                        |
-| :--------------------------------- | :------------------------------------------------------------------------------------------ | --- |
+| :--------------------------------- | :------------------------------------------------------------------------------------------ |
 | greptimedb.use_os_signal           | 是否使用 OS Signal。SDK 会默认监听 SIGUSR2 信号并输出一些信息，这对解决复杂问题非常有帮助。 |
 | greptimedb.signal.out_dir          | 指定 signal handler 的输出目录，默认是进程启动目录。                                        |
 | greptimedb.available_cpus          | 指定可用 cpu 数量，默认使用当前环境的全部 cpu 数量。                                        |
 | greptimedb.reporter.period_minutes | Metrics Reporter 定时输出周期，默认 30 分钟。                                               |
-| greptimedb.read.write.rw_logging   | 每次读写操作是否打印日志，默认关闭。                                                        |     |
+| greptimedb.read.write.rw_logging   | 每次读写操作是否打印日志，默认关闭。                                                        |
 
 ## 指标与显示
 

diff --git a/docs/zh/v0.4/user-guide/clients/sdk-libraries/go.md b/docs/zh/v0.4/user-guide/clients/sdk-libraries/go.md
@@ -39,7 +39,7 @@ func InitClient() *greptime.Client {
 }
 ```
 
-请参考 [Go SDK in reference](/zh/v0.4/reference/sdk/go.md) 以获得更多信息.
+请参考 [Go SDK in reference](../../../reference/sdk/go.md) 以获得更多信息.
 
 ## 写入数据
 

diff --git a/docs/zh/v0.4/user-guide/clients/sdk-libraries/java.md b/docs/zh/v0.4/user-guide/clients/sdk-libraries/java.md
@@ -81,7 +81,7 @@ public class QuickStart {
 }
 ```
 
-请前往 [Java SDK in reference](/zh/v0.4/reference/sdk/java.md) 获得更多的配置和指标信息。
+请前往 [Java SDK in reference](../../../reference/sdk/java.md) 获得更多的配置和指标信息。
 
 ## 写入数据