Skip to content

Commit

Permalink
chore: fixup links (#748)
Browse files Browse the repository at this point in the history
Signed-off-by: tison <[email protected]>
  • Loading branch information
tisonkun authored Jan 2, 2024
1 parent 2d04ffb commit 469b114
Show file tree
Hide file tree
Showing 23 changed files with 81 additions and 80 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ Explains how to use, integrate or customize GreptimeDB; also includes common iss

Provides a detailed overview of how GreptimeDB operates and assists you in participating as a contributor in its development

- [Overview](https://docs.greptime.com/developer-guide/overview)
- [Frontend](https://docs.greptime.com/developer-guide/frontend/overview)
- [Datanode](https://docs.greptime.com/developer-guide/datanode/overview)
- [Metasrv](https://docs.greptime.com/developer-guide/metasrv/overview)
- [Overview](https://docs.greptime.com/contributor-guide/overview)
- [Frontend](https://docs.greptime.com/contributor-guide/frontend/overview)
- [Datanode](https://docs.greptime.com/contributor-guide/datanode/overview)
- [Metasrv](https://docs.greptime.com/contributor-guide/metasrv/overview)

Please refer to [contribution guidelines](./CONTRIBUTING.md) for more information.
Please refer to [contribution guidelines](CONTRIBUTING.md) for more information.
1 change: 1 addition & 0 deletions docs/auto-imports.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ declare global {
const toRaw: typeof import('vue')['toRaw']
const toRef: typeof import('vue')['toRef']
const toRefs: typeof import('vue')['toRefs']
const toValue: typeof import('vue')['toValue']
const triggerRef: typeof import('vue')['triggerRef']
const unref: typeof import('vue')['unref']
const useAttrs: typeof import('vue')['useAttrs']
Expand Down
8 changes: 4 additions & 4 deletions docs/v0.3/en/faq-and-others/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ GreptimeDB supports SQL and can deal with non-time-series data, especially effic

Yes, you can find our Golang SDK [here](https://github.com/GreptimeTeam/greptimedb-client-go).

Currently, we support MySQL protocol, you can check it out on the [user guide](https://docs.greptime.com/user-guide/supported-protocols/mysql).
Currently, we support MySQL protocol, you can check it out on the [user guide](/user-guide/clients/mysql).

HTTP API is also available, please see [this article](https://docs.greptime.com/user-guide/supported-protocols/http-api) for more information.
HTTP API is also available, please see [this article](/user-guide/clients/http-api) for more information.

## Can GreptimeDB be used as a Rust alternative to Prometheus in the observable area?

Expand Down Expand Up @@ -54,7 +54,7 @@ Please check out our initial version on [GitHub Repo](https://github.com/Greptim
## Does GreptimeDB support schemaless?

Yes, GreptimeDB is a schemaless database without need for creating tables in advance. The table and columns will be created automatically when writing data with protocol gRPC, InfluxDB, OpentsDB, Prometheus remote write.
For more information, refer to [this document](https://docs.greptime.com/user-guide/table-management#create-table).
For more information, refer to [this document](/user-guide/table-management#create-table).

## How do you measure the passing rate of PromQL compatibility tests? Is there any testing framework?

Expand All @@ -70,7 +70,7 @@ Yes, beginners can filter issues with ["good first issue"](https://github.com/Gr

## Does GreptimeDB support dumping table-level data to S3?

You can use the [`COPY TO` command](https://docs.greptime.com/reference/sql/copy#s3) to dump table-level data to S3.
You can use the [`COPY TO` command](/reference/sql/copy#s3) to dump table-level data to S3.

## TSDB features that you concern

Expand Down
16 changes: 8 additions & 8 deletions docs/v0.3/en/greptimecloud/integrations/sdk-libraries/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ The following code snippet shows how to create a client.
String endpoint = "<host>:4001";
AuthInfo authInfo = new AuthInfo("<username>", "<password>");

GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint) //
GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint)
.authInfo(authInfo)
.writeMaxRetries(1) //
.readMaxRetries(2) //
.routeTableRefreshPeriodSeconds(-1) //
.writeMaxRetries(1)
.readMaxRetries(2)
.routeTableRefreshPeriodSeconds(-1)
.build();

GreptimeDB greptimeDB = new GreptimeDB();
Expand All @@ -33,9 +33,9 @@ if (!greptimeDB.init(opts)) {
After creating a GreptimeDB client, you can set database while writing data or querying data. For example query data:

```java
QueryRequest request = QueryRequest.newBuilder() //
.exprType(SelectExprType.Sql) //
.ql("SELECT * FROM monitor;") //
.databaseName("<dbname>") //
QueryRequest request = QueryRequest.newBuilder()
.exprType(SelectExprType.Sql)
.ql("SELECT * FROM monitor;")
.databaseName("<dbname>")
.build();
```
2 changes: 1 addition & 1 deletion docs/v0.3/en/user-guide/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You can follow the steps to use SQL to play with distributed insertions and quer
Query OK, 3 rows affected (0.09 sec)
```

The `dist_table` is distributed among the `Datanode`s. You can refer to ["Table Sharding"](https://docs.greptime.com/developer-guide/frontend/table-sharding) for more details.
The `dist_table` is distributed among the `Datanode`s. You can refer to ["Table Sharding"](/developer-guide/frontend/table-sharding) for more details.

3. Insert some data via `INSERT` statement.

Expand Down
2 changes: 1 addition & 1 deletion docs/v0.3/zh/db-cloud-shared/clients/otlp-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ GreptimeDB 通过原生支持 [OTLP/HTTP](https://opentelemetry.io/docs/specs/ot
* URL: `https://<host>/v1/otlp/v1/metrics`
* Headers:
* `X-Greptime-DB-Name`: `<dbname>`
* `Authorization`: `Basic` 认证,是 `<username>:<password>` 的 Base64 编码字符串。更多信息请参考 [鉴权](https://docs.greptime.cn/user-guide/clients/authentication)[HTTP API](https://docs.greptime.com/user-guide/clients/http-api#authentication)
* `Authorization`: `Basic` 认证,是 `<username>:<password>` 的 Base64 编码字符串。更多信息请参考 [鉴权](https://docs.greptime.cn/user-guide/clients/authentication)[HTTP API](https://docs.greptime.cn/user-guide/clients/http-api#authentication)

请求中使用 binary protobuf 编码 payload,因此你需要使用支持 `HTTP/protobuf` 的包。例如,在 Node.js 中,可以使用 [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto);在 Go 中,可以使用 [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp);在 Java 中,可以使用 [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp);在 Python 中,可以使用 [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Go SDK

GreptimeDB Go SDK 使用 gRPC 与数据库通信,
请参考 [Go SDK 文档](https://docs.greptime.com/user-guide/clients/sdk-libraries/go)查看更多 SDK 使用的相关内容。
请参考 [Go SDK 文档](https://docs.greptime.cn/user-guide/clients/sdk-libraries/go)查看更多 SDK 使用的相关内容。

请使用以下信息连接到 GreptimeCloud:

Expand Down
18 changes: 9 additions & 9 deletions docs/v0.3/zh/greptimecloud/integrations/sdk-libraries/java.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Java SDK

GreptimeDB Java SDK 使用 gRPC 与数据库通信,
请参考 [Java SDK 文档](https://docs.greptime.com/user-guide/clients/sdk-libraries/java)查看更多 SDK 使用的相关内容。
请参考 [Java SDK 文档](https://docs.greptime.cn/user-guide/clients/sdk-libraries/java)查看更多 SDK 使用的相关内容。

请使用以下信息连接到 GreptimeCloud:

Expand All @@ -17,11 +17,11 @@ GreptimeDB Java SDK 使用 gRPC 与数据库通信,
String endpoint = "<host>:4001";
AuthInfo authInfo = new AuthInfo("<username>", "<password>");

GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint) //
GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint)
.authInfo(authInfo)
.writeMaxRetries(1) //
.readMaxRetries(2) //
.routeTableRefreshPeriodSeconds(-1) //
.writeMaxRetries(1)
.readMaxRetries(2)
.routeTableRefreshPeriodSeconds(-1)
.build();

GreptimeDB greptimeDB = new GreptimeDB();
Expand All @@ -34,9 +34,9 @@ if (!greptimeDB.init(opts)) {
在创建了 GreptimeDB 客户端之后,你可以在写入数据或查询数据时设置数据库。例如查询数据:

```java
QueryRequest request = QueryRequest.newBuilder() //
.exprType(SelectExprType.Sql) //
.ql("SELECT * FROM monitor;") //
.databaseName("<dbname>") //
QueryRequest request = QueryRequest.newBuilder()
.exprType(SelectExprType.Sql)
.ql("SELECT * FROM monitor;")
.databaseName("<dbname>")
.build();
```
8 changes: 4 additions & 4 deletions docs/v0.4/en/faq-and-others/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ GreptimeDB supports SQL and can deal with non-time-series data, especially effic

Yes, you can find our Golang SDK [here](https://github.com/GreptimeTeam/greptimedb-client-go).

Currently, we support MySQL protocol, you can check it out on the [user guide](https://docs.greptime.com/user-guide/supported-protocols/mysql).
Currently, we support MySQL protocol, you can check it out on the [user guide](/user-guide/clients/mysql).

HTTP API is also available, please see [this article](https://docs.greptime.com/user-guide/supported-protocols/http-api) for more information.
HTTP API is also available, please see [this article](/user-guide/clients/http-api) for more information.

## Can GreptimeDB be used as a Rust alternative to Prometheus in the observable area?

Expand Down Expand Up @@ -55,7 +55,7 @@ Please check out our initial version on [GitHub Repo](https://github.com/Greptim
## Does GreptimeDB support schemaless?

Yes, GreptimeDB is a schemaless database without need for creating tables in advance. The table and columns will be created automatically when writing data with protocol gRPC, InfluxDB, OpentsDB, Prometheus remote write.
For more information, refer to [this document](https://docs.greptime.com/user-guide/table-management#create-table).
For more information, refer to [this document](/user-guide/table-management#create-table).

## How do you measure the passing rate of PromQL compatibility tests? Is there any testing framework?

Expand All @@ -71,7 +71,7 @@ Yes, beginners can filter issues with ["good first issue"](https://github.com/Gr

## Does GreptimeDB support dumping table-level data to S3?

You can use the [`COPY TO` command](https://docs.greptime.com/reference/sql/copy#s3) to dump table-level data to S3.
You can use the [`COPY TO` command](/reference/sql/copy#s3) to dump table-level data to S3.

## TSDB features that you concern

Expand Down
16 changes: 8 additions & 8 deletions docs/v0.4/en/greptimecloud/integrations/sdk-libraries/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ The following code snippet shows how to create a client.
String endpoint = "<host>:4001";
AuthInfo authInfo = new AuthInfo("<username>", "<password>");

GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint) //
GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint)
.authInfo(authInfo)
.writeMaxRetries(1) //
.readMaxRetries(2) //
.routeTableRefreshPeriodSeconds(-1) //
.writeMaxRetries(1)
.readMaxRetries(2)
.routeTableRefreshPeriodSeconds(-1)
.build();

GreptimeDB greptimeDB = new GreptimeDB();
Expand All @@ -33,9 +33,9 @@ if (!greptimeDB.init(opts)) {
After creating a GreptimeDB client, you can set database while writing data or querying data. For example query data:

```java
QueryRequest request = QueryRequest.newBuilder() //
.exprType(SelectExprType.Sql) //
.ql("SELECT * FROM monitor;") //
.databaseName("<dbname>") //
QueryRequest request = QueryRequest.newBuilder()
.exprType(SelectExprType.Sql)
.ql("SELECT * FROM monitor;")
.databaseName("<dbname>")
.build();
```
2 changes: 1 addition & 1 deletion docs/v0.4/en/user-guide/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You can follow the steps to use SQL to play with distributed insertions and quer
Query OK, 3 rows affected (0.09 sec)
```

The `dist_table` is distributed among the `Datanode`s. You can refer to ["Table Sharding"](https://docs.greptime.com/developer-guide/frontend/table-sharding) for more details.
The `dist_table` is distributed among the `Datanode`s. You can refer to ["Table Sharding"](/developer-guide/frontend/table-sharding) for more details.

3. Insert some data via `INSERT` statement.

Expand Down
2 changes: 1 addition & 1 deletion docs/v0.4/en/user-guide/operations/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ store_addr = "127.0.0.1:2379"
# Datanode selector type.
# - "lease_based" (default value).
# - "load_based"
# For details, please see "https://docs.greptime.com/developer-guide/meta/selector".
# For details, please see "https://docs.greptime.com/contributor-guide/meta/selector".
selector = "LeaseBased"
# Store data in memory, false by default.
use_memory_store = false
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.4/zh/db-cloud-shared/clients/otlp-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ GreptimeDB 通过原生支持 [OTLP/HTTP](https://opentelemetry.io/docs/specs/ot
* URL: `https://<host>/v1/otlp/v1/metrics`
* Headers:
* `X-Greptime-DB-Name`: `<dbname>`
* `Authorization`: `Basic` 认证,是 `<username>:<password>` 的 Base64 编码字符串。更多信息请参考 [鉴权](https://docs.greptime.cn/user-guide/clients/authentication)[HTTP API](https://docs.greptime.com/user-guide/clients/http-api#authentication)
* `Authorization`: `Basic` 认证,是 `<username>:<password>` 的 Base64 编码字符串。更多信息请参考 [鉴权](https://docs.greptime.cn/user-guide/clients/authentication)[HTTP API](https://docs.greptime.cn/user-guide/clients/http-api#authentication)

请求中使用 binary protobuf 编码 payload,因此你需要使用支持 `HTTP/protobuf` 的包。例如,在 Node.js 中,可以使用 [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto);在 Go 中,可以使用 [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp);在 Java 中,可以使用 [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp);在 Python 中,可以使用 [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Go SDK

GreptimeDB Go SDK 使用 gRPC 与数据库通信,
请参考 [Go SDK 文档](https://docs.greptime.com/user-guide/clients/sdk-libraries/go)查看更多 SDK 使用的相关内容。
请参考 [Go SDK 文档](https://docs.greptime.cn/user-guide/clients/sdk-libraries/go)查看更多 SDK 使用的相关内容。

请使用以下信息连接到 GreptimeCloud:

Expand Down
18 changes: 9 additions & 9 deletions docs/v0.4/zh/greptimecloud/integrations/sdk-libraries/java.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Java SDK

GreptimeDB Java SDK 使用 gRPC 与数据库通信,
请参考 [Java SDK 文档](https://docs.greptime.com/user-guide/clients/sdk-libraries/java)查看更多 SDK 使用的相关内容。
请参考 [Java SDK 文档](https://docs.greptime.cn/user-guide/clients/sdk-libraries/java)查看更多 SDK 使用的相关内容。

请使用以下信息连接到 GreptimeCloud:

Expand All @@ -17,11 +17,11 @@ GreptimeDB Java SDK 使用 gRPC 与数据库通信,
String endpoint = "<host>:4001";
AuthInfo authInfo = new AuthInfo("<username>", "<password>");

GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint) //
GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint)
.authInfo(authInfo)
.writeMaxRetries(1) //
.readMaxRetries(2) //
.routeTableRefreshPeriodSeconds(-1) //
.writeMaxRetries(1)
.readMaxRetries(2)
.routeTableRefreshPeriodSeconds(-1)
.build();

GreptimeDB greptimeDB = new GreptimeDB();
Expand All @@ -34,9 +34,9 @@ if (!greptimeDB.init(opts)) {
在创建了 GreptimeDB 客户端之后,你可以在写入数据或查询数据时设置数据库。例如查询数据:

```java
QueryRequest request = QueryRequest.newBuilder() //
.exprType(SelectExprType.Sql) //
.ql("SELECT * FROM monitor;") //
.databaseName("<dbname>") //
QueryRequest request = QueryRequest.newBuilder()
.exprType(SelectExprType.Sql)
.ql("SELECT * FROM monitor;")
.databaseName("<dbname>")
.build();
```
2 changes: 1 addition & 1 deletion docs/v0.4/zh/user-guide/operations/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ store_addr = "127.0.0.1:2379"
# Datanode selector type.
# - "lease_based" (default value).
# - "load_based"
# For details, please see "https://docs.greptime.com/developer-guide/meta/selector".
# For details, please see "https://docs.greptime.com/contributor-guide/meta/selector".
selector = "lease_based"
# Store data in memory, false by default.
use_memory_store = false
Expand Down
8 changes: 4 additions & 4 deletions docs/v0.5/en/faq-and-others/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ GreptimeDB supports SQL and can deal with non-time-series data, especially effic

Yes, you can find our Golang SDK [here](https://github.com/GreptimeTeam/greptimedb-client-go).

Currently, we support MySQL protocol, you can check it out on the [user guide](https://docs.greptime.com/user-guide/supported-protocols/mysql).
Currently, we support MySQL protocol, you can check it out on the [user guide](/user-guide/clients/mysql).

HTTP API is also available, please see [this article](https://docs.greptime.com/user-guide/supported-protocols/http-api) for more information.
HTTP API is also available, please see [this article](/user-guide/clients/http-api) for more information.

## Can GreptimeDB be used as a Rust alternative to Prometheus in the observable area?

Expand Down Expand Up @@ -55,7 +55,7 @@ Please check out our initial version on [GitHub Repo](https://github.com/Greptim
## Does GreptimeDB support schemaless?

Yes, GreptimeDB is a schemaless database without need for creating tables in advance. The table and columns will be created automatically when writing data with protocol gRPC, InfluxDB, OpentsDB, Prometheus remote write.
For more information, refer to [this document](https://docs.greptime.com/user-guide/table-management#create-table).
For more information, refer to [this document](/user-guide/table-management#create-table).

## How do you measure the passing rate of PromQL compatibility tests? Is there any testing framework?

Expand All @@ -71,7 +71,7 @@ Yes, beginners can filter issues with ["good first issue"](https://github.com/Gr

## Does GreptimeDB support dumping table-level data to S3?

You can use the [`COPY TO` command](https://docs.greptime.com/reference/sql/copy#s3) to dump table-level data to S3.
You can use the [`COPY TO` command](/reference/sql/copy#s3) to dump table-level data to S3.

## TSDB features that you concern

Expand Down
16 changes: 8 additions & 8 deletions docs/v0.5/en/greptimecloud/integrations/sdk-libraries/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ The following code snippet shows how to create a client.
String endpoint = "<host>:4001";
AuthInfo authInfo = new AuthInfo("<username>", "<password>");

GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint) //
GreptimeOptions opts = GreptimeOptions.newBuilder(endpoint)
.authInfo(authInfo)
.writeMaxRetries(1) //
.readMaxRetries(2) //
.routeTableRefreshPeriodSeconds(-1) //
.writeMaxRetries(1)
.readMaxRetries(2)
.routeTableRefreshPeriodSeconds(-1)
.build();

GreptimeDB greptimeDB = new GreptimeDB();
Expand All @@ -33,9 +33,9 @@ if (!greptimeDB.init(opts)) {
After creating a GreptimeDB client, you can set database while writing data or querying data. For example query data:

```java
QueryRequest request = QueryRequest.newBuilder() //
.exprType(SelectExprType.Sql) //
.ql("SELECT * FROM monitor;") //
.databaseName("<dbname>") //
QueryRequest request = QueryRequest.newBuilder()
.exprType(SelectExprType.Sql)
.ql("SELECT * FROM monitor;")
.databaseName("<dbname>")
.build();
```
2 changes: 1 addition & 1 deletion docs/v0.5/en/user-guide/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You can follow the steps to use SQL to play with distributed insertions and quer
Query OK, 3 rows affected (0.09 sec)
```

The `dist_table` is distributed among the `Datanode`s. You can refer to ["Table Sharding"](https://docs.greptime.com/contributor-guide/frontend/table-sharding) for more details.
The `dist_table` is distributed among the `Datanode`s. You can refer to ["Table Sharding"](/contributor-guide/frontend/table-sharding) for more details.

3. Insert some data via `INSERT` statement.

Expand Down
Loading

0 comments on commit 469b114

Please sign in to comment.