From 6d1a5058e4fb04e68639d6023c06885feb7bd807 Mon Sep 17 00:00:00 2001 From: tison Date: Thu, 16 May 2024 10:57:04 +0800 Subject: [PATCH] ci: check typos (#957) Signed-off-by: tison --- .github/pr-title-checker-config.json | 10 --------- .github/workflows/linter.yml | 21 +++++++++++++++++++ .github/workflows/mdlint.yml | 18 ---------------- .../workflows/{node.js.yml => node-build.yml} | 6 +++--- ...-checker.yml => semantic-pull-request.yml} | 10 ++++----- .../frontend/distributed-querying.md | 2 +- .../db-cloud-shared/quick-start/influxdb.md | 2 +- .../en/db-cloud-shared/quick-start/mysql.md | 2 +- .../tutorials/monitor-host-metrics/go-demo.md | 2 +- .../monitor-host-metrics/java-demo.md | 2 +- .../monitor-host-metrics/node-js-demo.md | 2 +- .../monitor-host-metrics/prometheus-demo.md | 2 +- .../monitor-host-metrics/python-demo.md | 2 +- .../installation/greptimedb-dashboard.md | 2 +- docs/nightly/en/reference/command-lines.md | 2 +- docs/nightly/en/reference/sql/copy.md | 2 +- docs/nightly/en/reference/sql/range.md | 2 +- .../en/user-guide/client-libraries/java.md | 2 +- .../en/user-guide/clients/influxdb-line.md | 2 +- docs/nightly/en/user-guide/cluster.md | 2 +- .../en/user-guide/concepts/overview.md | 2 +- .../migrate-from-influxdb.md | 2 +- .../python-scripts/getting-started.md | 2 +- .../en/user-guide/query-data/promql.md | 2 +- .../nightly/en/user-guide/table-management.md | 2 +- docs/nightly/zh/user-guide/clients/otlp.md | 2 +- .../zh/user-guide/query-data/promql.md | 2 +- docs/release-notes/release-0-7-0.md | 2 +- docs/release-notes/release-0-7-1.md | 2 +- docs/release-notes/release-0-7-2.md | 2 +- .../tutorials/monitor-host-metrics/go-demo.md | 2 +- .../monitor-host-metrics/java-demo.md | 2 +- .../monitor-host-metrics/node-js-demo.md | 2 +- .../monitor-host-metrics/prometheus-demo.md | 2 +- .../monitor-host-metrics/python-demo.md | 2 +- .../getting-started/quick-start/influxdb.md | 2 +- .../getting-started/quick-start/mysql.md | 2 +- docs/v0.3/en/reference/data-types.md | 2 +- docs/v0.3/en/reference/sdk/go.md | 2 +- docs/v0.3/en/reference/sdk/java.md | 2 +- .../en/user-guide/clients/influxdb-line.md | 2 +- docs/v0.3/en/user-guide/cluster.md | 2 +- docs/v0.3/en/user-guide/concepts/overview.md | 2 +- docs/v0.3/en/user-guide/query-data/promql.md | 2 +- docs/v0.3/en/user-guide/table-management.md | 2 +- docs/v0.3/zh/reference/data-types.md | 2 +- docs/v0.3/zh/user-guide/clients/otlp.md | 2 +- docs/v0.3/zh/user-guide/query-data/promql.md | 2 +- .../db-cloud-shared/quick-start/influxdb.md | 2 +- .../en/db-cloud-shared/quick-start/mysql.md | 2 +- .../tutorials/monitor-host-metrics/go-demo.md | 2 +- .../monitor-host-metrics/java-demo.md | 2 +- .../monitor-host-metrics/node-js-demo.md | 2 +- .../monitor-host-metrics/prometheus-demo.md | 2 +- .../monitor-host-metrics/python-demo.md | 2 +- .../frontend/distributed-querying.md | 2 +- docs/v0.4/en/reference/command-lines.md | 2 +- docs/v0.4/en/reference/data-types.md | 2 +- docs/v0.4/en/reference/sql/range.md | 2 +- .../en/user-guide/clients/influxdb-line.md | 2 +- docs/v0.4/en/user-guide/cluster.md | 2 +- docs/v0.4/en/user-guide/concepts/overview.md | 2 +- .../en/user-guide/operations/configuration.md | 2 +- .../en/user-guide/operations/monitoring.md | 2 +- docs/v0.4/en/user-guide/query-data/promql.md | 2 +- .../scripts-&-functions/getting-started.md | 2 +- docs/v0.4/en/user-guide/table-management.md | 2 +- docs/v0.4/zh/reference/data-types.md | 2 +- docs/v0.4/zh/user-guide/clients/otlp.md | 2 +- .../zh/user-guide/operations/monitoring.md | 2 +- docs/v0.4/zh/user-guide/query-data/promql.md | 2 +- .../frontend/distributed-querying.md | 2 +- .../db-cloud-shared/quick-start/influxdb.md | 2 +- .../en/db-cloud-shared/quick-start/mysql.md | 2 +- .../tutorials/monitor-host-metrics/go-demo.md | 2 +- .../monitor-host-metrics/java-demo.md | 2 +- .../monitor-host-metrics/node-js-demo.md | 2 +- .../monitor-host-metrics/prometheus-demo.md | 2 +- .../monitor-host-metrics/python-demo.md | 2 +- docs/v0.5/en/reference/command-lines.md | 2 +- docs/v0.5/en/reference/data-types.md | 2 +- docs/v0.5/en/reference/sql/range.md | 2 +- .../en/user-guide/client-libraries/java.md | 2 +- .../en/user-guide/clients/influxdb-line.md | 2 +- docs/v0.5/en/user-guide/cluster.md | 2 +- docs/v0.5/en/user-guide/concepts/overview.md | 2 +- .../en/user-guide/operations/configuration.md | 2 +- .../en/user-guide/operations/monitoring.md | 2 +- .../python-scripts/getting-started.md | 2 +- docs/v0.5/en/user-guide/query-data/promql.md | 2 +- docs/v0.5/en/user-guide/table-management.md | 2 +- docs/v0.5/zh/reference/data-types.md | 2 +- docs/v0.5/zh/user-guide/clients/otlp.md | 2 +- .../zh/user-guide/operations/monitoring.md | 2 +- docs/v0.5/zh/user-guide/query-data/promql.md | 2 +- .../frontend/distributed-querying.md | 2 +- .../db-cloud-shared/quick-start/influxdb.md | 2 +- .../en/db-cloud-shared/quick-start/mysql.md | 2 +- .../tutorials/monitor-host-metrics/go-demo.md | 2 +- .../monitor-host-metrics/java-demo.md | 2 +- .../monitor-host-metrics/node-js-demo.md | 2 +- .../monitor-host-metrics/prometheus-demo.md | 2 +- .../monitor-host-metrics/python-demo.md | 2 +- .../installation/greptimedb-dashboard.md | 2 +- docs/v0.6/en/reference/command-lines.md | 2 +- docs/v0.6/en/reference/sql/copy.md | 2 +- docs/v0.6/en/reference/sql/range.md | 2 +- .../en/user-guide/client-libraries/java.md | 2 +- .../en/user-guide/clients/influxdb-line.md | 2 +- docs/v0.6/en/user-guide/cluster.md | 2 +- docs/v0.6/en/user-guide/concepts/overview.md | 2 +- .../en/user-guide/operations/configuration.md | 2 +- .../python-scripts/getting-started.md | 2 +- docs/v0.6/en/user-guide/query-data/promql.md | 2 +- docs/v0.6/en/user-guide/table-management.md | 2 +- docs/v0.6/zh/user-guide/clients/otlp.md | 2 +- docs/v0.6/zh/user-guide/query-data/promql.md | 2 +- .../frontend/distributed-querying.md | 2 +- .../db-cloud-shared/quick-start/influxdb.md | 2 +- .../en/db-cloud-shared/quick-start/mysql.md | 2 +- .../tutorials/monitor-host-metrics/go-demo.md | 2 +- .../monitor-host-metrics/java-demo.md | 2 +- .../monitor-host-metrics/node-js-demo.md | 2 +- .../monitor-host-metrics/prometheus-demo.md | 2 +- .../monitor-host-metrics/python-demo.md | 2 +- .../installation/greptimedb-dashboard.md | 2 +- docs/v0.7/en/reference/command-lines.md | 2 +- docs/v0.7/en/reference/sql/copy.md | 2 +- docs/v0.7/en/reference/sql/range.md | 2 +- .../en/user-guide/client-libraries/java.md | 2 +- .../en/user-guide/clients/influxdb-line.md | 2 +- docs/v0.7/en/user-guide/cluster.md | 2 +- docs/v0.7/en/user-guide/concepts/overview.md | 2 +- .../migrate-from-influxdb.md | 2 +- .../en/user-guide/operations/configuration.md | 2 +- .../python-scripts/getting-started.md | 2 +- docs/v0.7/en/user-guide/query-data/promql.md | 2 +- docs/v0.7/en/user-guide/table-management.md | 2 +- docs/v0.7/zh/user-guide/clients/otlp.md | 2 +- docs/v0.7/zh/user-guide/query-data/promql.md | 2 +- typos.toml | 8 +++++++ 141 files changed, 172 insertions(+), 171 deletions(-) delete mode 100644 .github/pr-title-checker-config.json create mode 100644 .github/workflows/linter.yml delete mode 100644 .github/workflows/mdlint.yml rename .github/workflows/{node.js.yml => node-build.yml} (88%) rename .github/workflows/{pr-title-checker.yml => semantic-pull-request.yml} (56%) create mode 100644 typos.toml diff --git a/.github/pr-title-checker-config.json b/.github/pr-title-checker-config.json deleted file mode 100644 index f270dc671..000000000 --- a/.github/pr-title-checker-config.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "LABEL": { - "name": "Invalid PR Title", - "color": "B60205" - }, - "CHECKS": { - "regexp": "^(feat|fix|test|refactor|chore|style|docs|perf|build|ci|revert)(\\(.*\\))?:.*", - "ignoreLabels" : ["ignore-title"] - } -} diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml new file mode 100644 index 000000000..33b96d80c --- /dev/null +++ b/.github/workflows/linter.yml @@ -0,0 +1,21 @@ +name: Linters + +on: + push: + branches: + - main + pull_request: + +jobs: + linter: + name: Run Linters + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Markdown lint + uses: nosborn/github-action-markdown-cli@v3.2.0 + with: + files: "./**/*.md" + config_file: .markdownlint.yaml + - name: Check typos + uses: crate-ci/typos@master diff --git a/.github/workflows/mdlint.yml b/.github/workflows/mdlint.yml deleted file mode 100644 index 808267f38..000000000 --- a/.github/workflows/mdlint.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Markdown Lint - -on: - push: - branches: - - main - pull_request: - -jobs: - build: - name: Markdown Lint - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: nosborn/github-action-markdown-cli@v3.2.0 - with: - files: "./**/*.md" - config_file: .markdownlint.yaml diff --git a/.github/workflows/node.js.yml b/.github/workflows/node-build.yml similarity index 88% rename from .github/workflows/node.js.yml rename to .github/workflows/node-build.yml index a77efaae6..f6eb449a2 100644 --- a/.github/workflows/node.js.yml +++ b/.github/workflows/node-build.yml @@ -17,13 +17,13 @@ jobs: # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Install pnpm - uses: pnpm/action-setup@v2 + uses: pnpm/action-setup@v4 with: version: 8.6.0 - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} cache: 'pnpm' diff --git a/.github/workflows/pr-title-checker.yml b/.github/workflows/semantic-pull-request.yml similarity index 56% rename from .github/workflows/pr-title-checker.yml rename to .github/workflows/semantic-pull-request.yml index d683c847f..6c2a351e5 100644 --- a/.github/workflows/pr-title-checker.yml +++ b/.github/workflows/semantic-pull-request.yml @@ -1,4 +1,5 @@ -name: "PR Title Checker" +name: Semantic Pull Request + on: pull_request_target: types: @@ -10,11 +11,10 @@ on: jobs: check: + name: Check pull request title runs-on: ubuntu-latest timeout-minutes: 10 steps: - - uses: thehanimo/pr-title-checker@v1.3.4 - with: + - uses: amannn/action-semantic-pull-request@v5 + env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - pass_on_octokit_error: false - configuration_path: ".github/pr-title-checker-config.json" diff --git a/docs/nightly/en/contributor-guide/frontend/distributed-querying.md b/docs/nightly/en/contributor-guide/frontend/distributed-querying.md index ee86c6ab3..f6f2399da 100644 --- a/docs/nightly/en/contributor-guide/frontend/distributed-querying.md +++ b/docs/nightly/en/contributor-guide/frontend/distributed-querying.md @@ -15,7 +15,7 @@ Planner will traverse the input logical plan, and split it into multiple stages rule](https://github.com/GreptimeTeam/greptimedb/blob/main/docs/rfcs/2023-05-09-distributed-planner.md)". This rule is under heavy development. At present it will consider things like: -- whether the operator ifself is commutative +- whether the operator itself is commutative - how the partition rule is configured - etc... diff --git a/docs/nightly/en/db-cloud-shared/quick-start/influxdb.md b/docs/nightly/en/db-cloud-shared/quick-start/influxdb.md index da2bcf001..febbc41a3 100644 --- a/docs/nightly/en/db-cloud-shared/quick-start/influxdb.md +++ b/docs/nightly/en/db-cloud-shared/quick-start/influxdb.md @@ -1,2 +1,2 @@ -To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). +To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). diff --git a/docs/nightly/en/db-cloud-shared/quick-start/mysql.md b/docs/nightly/en/db-cloud-shared/quick-start/mysql.md index de5963a6e..f8c8742bc 100644 --- a/docs/nightly/en/db-cloud-shared/quick-start/mysql.md +++ b/docs/nightly/en/db-cloud-shared/quick-start/mysql.md @@ -1,3 +1,3 @@ -To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). +To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). diff --git a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md index 0a7e5a920..77a9714a1 100644 --- a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md +++ b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md @@ -11,7 +11,7 @@ go get go.opentelemetry.io/otel@v1.16.0 \ ``` Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB in `app.go`. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```go auth := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", *username, *password))) diff --git a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md index 7b1e28d98..262dce433 100644 --- a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md +++ b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md @@ -21,7 +21,7 @@ dependencies { } ``` -Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```java String endpoint = String.format("https://%s/v1/otlp/v1/metrics", dbHost); diff --git a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md index a751d942b..e66e605f0 100644 --- a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md +++ b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md @@ -25,7 +25,7 @@ npm install @opentelemetry/api@1.4.1 \ ``` Once the required packages are installed,create a new file named `app.ts` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```ts const exporter = new OTLPMetricExporter({ diff --git a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md index 35d22a9a7..7158baaa6 100644 --- a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md +++ b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md @@ -53,7 +53,7 @@ remote_write: password: ``` -The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). +The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configuration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). Finally, start the containers: diff --git a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md index 13baa5147..2be6d8e82 100644 --- a/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md +++ b/docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md @@ -25,7 +25,7 @@ pip install -r requirements.txt ``` Once the required packages are installed,create a new file named `main.py` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```python from opentelemetry import metrics diff --git a/docs/nightly/en/getting-started/installation/greptimedb-dashboard.md b/docs/nightly/en/getting-started/installation/greptimedb-dashboard.md index 020285c1f..d62571223 100644 --- a/docs/nightly/en/getting-started/installation/greptimedb-dashboard.md +++ b/docs/nightly/en/getting-started/installation/greptimedb-dashboard.md @@ -2,7 +2,7 @@ Visualization plays a crucial role in effectively utilizing time series data. To help users leverage the various features of GreptimeDB, Greptime offers a simple [dashboard](https://github.com/GreptimeTeam/dashboard). -The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports mutiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md). +The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports multiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md). We offer various chart types to choose from based on different scenarios. The charts become more informative when you have sufficient data. diff --git a/docs/nightly/en/reference/command-lines.md b/docs/nightly/en/reference/command-lines.md index 5d13f8e6d..82c6e5799 100644 --- a/docs/nightly/en/reference/command-lines.md +++ b/docs/nightly/en/reference/command-lines.md @@ -39,7 +39,7 @@ Starts GreptimeDB in standalone mode with customized configurations: greptime --log-dir=/tmp/greptimedb/logs --log-level=info standalone start -c config/standalone.example.toml ``` -The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuraiton files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). +The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). To start GreptimeDB in distributed mode, you need to start each component separately. The following commands show how to start each component with customized configurations or command line arguments. diff --git a/docs/nightly/en/reference/sql/copy.md b/docs/nightly/en/reference/sql/copy.md index 29b2c1ca5..db7aff389 100644 --- a/docs/nightly/en/reference/sql/copy.md +++ b/docs/nightly/en/reference/sql/copy.md @@ -145,7 +145,7 @@ COPY DATABASE | `FORMAT` | Export file format, available options: JSON, CSV, Parquet | **Required** | | `START_TIME`/`END_TIME`| The time range within which data should be exported. `START_TIME` is inclusive and `END_TIME` is exclusive. | Optional | -> - When copying databses, `` must end with `/`. +> - When copying databases, `` must end with `/`. > - `CONNECTION` parameters can also be used to copying databases to/from object storage services like AWS S3. ### Examples diff --git a/docs/nightly/en/reference/sql/range.md b/docs/nightly/en/reference/sql/range.md index df71773ed..c2bdceb48 100644 --- a/docs/nightly/en/reference/sql/range.md +++ b/docs/nightly/en/reference/sql/range.md @@ -322,7 +322,7 @@ Suppose we have a tale `host` with the following data: +---------------------+-------+------+ ``` -The following SQL uses `host` as the aggragate key: +The following SQL uses `host` as the aggregate key: ```sql SELECT diff --git a/docs/nightly/en/user-guide/client-libraries/java.md b/docs/nightly/en/user-guide/client-libraries/java.md index bd83f141b..644a1a63e 100644 --- a/docs/nightly/en/user-guide/client-libraries/java.md +++ b/docs/nightly/en/user-guide/client-libraries/java.md @@ -387,7 +387,7 @@ For fully runnable code snippets and the complete code of the demo, please refer Java database connectivity (JDBC) is the JavaSoft specification of a standard application programming interface (API) that allows Java programs to access database management systems. Many databases, such as MySQL or PostgreSQL, have implemented their own drivers based on the JDBC API. -Since GreptimeDB supports [mutiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC. +Since GreptimeDB supports [multiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC. If you want to use other protocols, just replace the MySQL driver with the corresponding driver. %} diff --git a/docs/nightly/en/user-guide/clients/influxdb-line.md b/docs/nightly/en/user-guide/clients/influxdb-line.md index a3658db3d..4cb94d5e4 100644 --- a/docs/nightly/en/user-guide/clients/influxdb-line.md +++ b/docs/nightly/en/user-guide/clients/influxdb-line.md @@ -6,7 +6,7 @@ GreptimeDB is compatible with InfluxDB's line protocol authentication format, bo **[V2 protocol](https://docs.influxdata.com/influxdb/v1.8/tools/api/?t=Auth+Enabled#apiv2query-http-endpoint)** -InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protcol. +InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protocol. ```shell ❯ curl 'http://localhost:4000/v1/influxdb/api/v2/write?db=public' \ diff --git a/docs/nightly/en/user-guide/cluster.md b/docs/nightly/en/user-guide/cluster.md index 698554197..d309f6cee 100644 --- a/docs/nightly/en/user-guide/cluster.md +++ b/docs/nightly/en/user-guide/cluster.md @@ -2,7 +2,7 @@ ## Create a cluster -Please refer to [Kubernetes](./operations/kubernetes.md) to get the infomation about creating a Kubernetes cluster. +Please refer to [Kubernetes](./operations/kubernetes.md) to get the information about creating a Kubernetes cluster. ## Distributed Read/Write diff --git a/docs/nightly/en/user-guide/concepts/overview.md b/docs/nightly/en/user-guide/concepts/overview.md index c17bda840..bee3c88bf 100644 --- a/docs/nightly/en/user-guide/concepts/overview.md +++ b/docs/nightly/en/user-guide/concepts/overview.md @@ -1,6 +1,6 @@ # Overview -- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performence, and user-friendly. +- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performance, and user-friendly. - [Data Model](./data-model.md): This document describes the data model of GreptimeDB, including table schema, index columns, etc. - [Architecture](./architecture.md): Get the cloud-native architecture of GreptimeDB. - [Storage Location](./storage-location.md): This document describes the storage location of GreptimeDB, including local disk, HDFS, and cloud object storage such as S3, Azure Blob Storage, etc. diff --git a/docs/nightly/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md b/docs/nightly/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md index eca59daf9..040f1eac8 100644 --- a/docs/nightly/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md +++ b/docs/nightly/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md @@ -160,7 +160,7 @@ $writeApi->write($point); %} {template visualize-data% -It is recommanded using Grafana to visualize data in GreptimeDB. +It is recommended using Grafana to visualize data in GreptimeDB. Please refer to the [Grafana documentation](/user-guide/clients/grafana) for details on configuring GreptimeDB. %} diff --git a/docs/nightly/en/user-guide/python-scripts/getting-started.md b/docs/nightly/en/user-guide/python-scripts/getting-started.md index 5c1ea263b..c41654a5d 100644 --- a/docs/nightly/en/user-guide/python-scripts/getting-started.md +++ b/docs/nightly/en/user-guide/python-scripts/getting-started.md @@ -14,7 +14,7 @@ conda create --name Greptime python= + ## SQL diff --git a/docs/nightly/en/user-guide/table-management.md b/docs/nightly/en/user-guide/table-management.md index 2982c84b2..e4011fa6b 100644 --- a/docs/nightly/en/user-guide/table-management.md +++ b/docs/nightly/en/user-guide/table-management.md @@ -9,7 +9,7 @@ For more explanations of the `SQL` syntax, please see the [SQL reference](/refer ## Create Database -The default database is `public`. You can create a database manully. +The default database is `public`. You can create a database manually. ```sql CREATE DATABASE test; diff --git a/docs/nightly/zh/user-guide/clients/otlp.md b/docs/nightly/zh/user-guide/clients/otlp.md index b32963495..d0aed2b0a 100644 --- a/docs/nightly/zh/user-guide/clients/otlp.md +++ b/docs/nightly/zh/user-guide/clients/otlp.md @@ -79,5 +79,5 @@ OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型 - 所有的 Attribute ，包含 resource 级别、scope 级别和 data_point 级别，都被作为 GreptimeDB 表的 tag 列。 - 数据点的时间戳被作为 GreptimeDB 的时间戳索引，列名 greptime_timestamp。 - Gauge/Sum 两种类型的数据点数据被作为 field 列，列名 greptime_value。 -- Summay 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 +- Summary 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 - Histogram 和 ExponentialHistogram 暂时未被支持，我们可能在后续版本中推出 Histogram 数据类型来原生支持这两种类型。 diff --git a/docs/nightly/zh/user-guide/query-data/promql.md b/docs/nightly/zh/user-guide/query-data/promql.md index c906f488e..26d9244f2 100644 --- a/docs/nightly/zh/user-guide/query-data/promql.md +++ b/docs/nightly/zh/user-guide/query-data/promql.md @@ -112,7 +112,7 @@ curl -X GET \ "execution_time_ms": 5 } ``` - + ## SQL diff --git a/docs/release-notes/release-0-7-0.md b/docs/release-notes/release-0-7-0.md index b97796fc8..fb0fcab75 100644 --- a/docs/release-notes/release-0-7-0.md +++ b/docs/release-notes/release-0-7-0.md @@ -44,7 +44,7 @@ v0.7 represents a crucial leap toward achieving production readiness; it impleme * fix: bump libgit2-sys from 0.16.1+1.7.1 to 0.16.2+1.7.2 by [@dependabot](https://github.com/dependabot) in [#3316](https://github.com/GreptimeTeam/greptimedb/pull/3316) * fix: split write metadata request by [@fengjiachun](https://github.com/fengjiachun) in [#3311](https://github.com/GreptimeTeam/greptimedb/pull/3311) * fix(index): encode string type to original data to enable fst regex to work by [@zhongzc](https://github.com/zhongzc) in [#3324](https://github.com/GreptimeTeam/greptimedb/pull/3324) -* fix: disable ansi contorl char when stdout is redirected by [@waynexia](https://github.com/waynexia) in [#3332](https://github.com/GreptimeTeam/greptimedb/pull/3332) +* fix: disable ansi control char when stdout is redirected by [@waynexia](https://github.com/waynexia) in [#3332](https://github.com/GreptimeTeam/greptimedb/pull/3332) * fix: typo in lint config by [@waynexia](https://github.com/waynexia) in [#3358](https://github.com/GreptimeTeam/greptimedb/pull/3358) * fix: treat "0" and "1" as valid boolean values. by [@MichaelScofield](https://github.com/MichaelScofield) in [#3370](https://github.com/GreptimeTeam/greptimedb/pull/3370) * fix: remove unused imports in memtable_util.rs by [@v0y4g3r](https://github.com/v0y4g3r) in [#3376](https://github.com/GreptimeTeam/greptimedb/pull/3376) diff --git a/docs/release-notes/release-0-7-1.md b/docs/release-notes/release-0-7-1.md index a25723e16..b4fcae465 100644 --- a/docs/release-notes/release-0-7-1.md +++ b/docs/release-notes/release-0-7-1.md @@ -34,7 +34,7 @@ This is a patch release, containing an important bug fix while decoding the Prom * feat: clamp function by [@waynexia](https://github.com/waynexia) in [#3465](https://github.com/GreptimeTeam/greptimedb/pull/3465) * feat(fuzz): validate columns by [@WenyXu](https://github.com/WenyXu) in [#3485](https://github.com/GreptimeTeam/greptimedb/pull/3485) * feat: to_timezone function by [@tisonkun](https://github.com/tisonkun) in [#3470](https://github.com/GreptimeTeam/greptimedb/pull/3470) -* feat(flow): accumlator for aggr func by [@discord9](https://github.com/discord9) in [#3396](https://github.com/GreptimeTeam/greptimedb/pull/3396) +* feat(flow): accumulator for aggr func by [@discord9](https://github.com/discord9) in [#3396](https://github.com/GreptimeTeam/greptimedb/pull/3396) * feat(flow): plan def by [@discord9](https://github.com/discord9) in [#3490](https://github.com/GreptimeTeam/greptimedb/pull/3490) * feat: improve prom write requests decode performance by [@v0y4g3r](https://github.com/v0y4g3r) in [#3478](https://github.com/GreptimeTeam/greptimedb/pull/3478) * feat(fuzz): add insert target by [@zhongzc](https://github.com/zhongzc) in [#3499](https://github.com/GreptimeTeam/greptimedb/pull/3499) diff --git a/docs/release-notes/release-0-7-2.md b/docs/release-notes/release-0-7-2.md index 60d1ec2d8..2b20dd87b 100644 --- a/docs/release-notes/release-0-7-2.md +++ b/docs/release-notes/release-0-7-2.md @@ -76,7 +76,7 @@ This is a patch release, containing a critial bug fix to avoid wrongly delete da * refactor: introduce the DropTableExecutor by [@WenyXu](https://github.com/WenyXu) in [#3534](https://github.com/GreptimeTeam/greptimedb/pull/3534) * refactor: refactor CacheInvalidator by [@WenyXu](https://github.com/WenyXu) in [#3550](https://github.com/GreptimeTeam/greptimedb/pull/3550) * refactor: handle error for http format by [@tisonkun](https://github.com/tisonkun) in [#3548](https://github.com/GreptimeTeam/greptimedb/pull/3548) -* refactor: remove redudant PromStoreProtocolHandler::write by [@v0y4g3r](https://github.com/v0y4g3r) in [#3553](https://github.com/GreptimeTeam/greptimedb/pull/3553) +* refactor: remove redundant PromStoreProtocolHandler::write by [@v0y4g3r](https://github.com/v0y4g3r) in [#3553](https://github.com/GreptimeTeam/greptimedb/pull/3553) * refactor: reduce one clone by carefully pass ready boundary by [@tisonkun](https://github.com/tisonkun) in [#3543](https://github.com/GreptimeTeam/greptimedb/pull/3543) * refactor: try upgrade regex-automata by [@tisonkun](https://github.com/tisonkun) in [#3575](https://github.com/GreptimeTeam/greptimedb/pull/3575) * refactor: refactor drop table executor by [@WenyXu](https://github.com/WenyXu) in [#3589](https://github.com/GreptimeTeam/greptimedb/pull/3589) diff --git a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md index 0a7e5a920..77a9714a1 100644 --- a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md +++ b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md @@ -11,7 +11,7 @@ go get go.opentelemetry.io/otel@v1.16.0 \ ``` Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB in `app.go`. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```go auth := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", *username, *password))) diff --git a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md index 7b1e28d98..262dce433 100644 --- a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md +++ b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md @@ -21,7 +21,7 @@ dependencies { } ``` -Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```java String endpoint = String.format("https://%s/v1/otlp/v1/metrics", dbHost); diff --git a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md index a751d942b..e66e605f0 100644 --- a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md +++ b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md @@ -25,7 +25,7 @@ npm install @opentelemetry/api@1.4.1 \ ``` Once the required packages are installed,create a new file named `app.ts` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```ts const exporter = new OTLPMetricExporter({ diff --git a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md index 78040946e..3d65280ad 100644 --- a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md +++ b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md @@ -53,7 +53,7 @@ remote_write: password: ``` -The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). +The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configuration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). Finally, start the containers: diff --git a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md index 13baa5147..2be6d8e82 100644 --- a/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md +++ b/docs/v0.3/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md @@ -25,7 +25,7 @@ pip install -r requirements.txt ``` Once the required packages are installed,create a new file named `main.py` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```python from opentelemetry import metrics diff --git a/docs/v0.3/en/greptimecloud/getting-started/quick-start/influxdb.md b/docs/v0.3/en/greptimecloud/getting-started/quick-start/influxdb.md index 03fc3b3b6..68f2c24ac 100644 --- a/docs/v0.3/en/greptimecloud/getting-started/quick-start/influxdb.md +++ b/docs/v0.3/en/greptimecloud/getting-started/quick-start/influxdb.md @@ -5,4 +5,4 @@ To quickly get started with InfluxDB line protocol, we can use Bash to collect s curl -L https://raw.githubusercontent.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol/main/quick-start.sh | bash -s -- -h -d -u -p ``` -The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). +The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). diff --git a/docs/v0.3/en/greptimecloud/getting-started/quick-start/mysql.md b/docs/v0.3/en/greptimecloud/getting-started/quick-start/mysql.md index 056253aaa..46b757e05 100644 --- a/docs/v0.3/en/greptimecloud/getting-started/quick-start/mysql.md +++ b/docs/v0.3/en/greptimecloud/getting-started/quick-start/mysql.md @@ -5,4 +5,4 @@ To quickly get started with MySQL, we can use Bash to collect system metrics, su curl -L https://raw.githubusercontent.com/GreptimeCloudStarters/quick-start-mysql/main/quick-start.sh | bash -s -- -h -d -u -p ``` -The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). +The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). diff --git a/docs/v0.3/en/reference/data-types.md b/docs/v0.3/en/reference/data-types.md index f36a1e007..d5070b6e9 100644 --- a/docs/v0.3/en/reference/data-types.md +++ b/docs/v0.3/en/reference/data-types.md @@ -15,7 +15,7 @@ GreptimeDB supports the following data types: |`varbinary`|Variable length binary values| | The length of the data + 2 bytes| |`date`|32-bit date values|| 4 Bytes | |`datetime`|64-bit datetime values|| 8 Bytes | -|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseonds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|| 8 Bytes | +|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseconds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|| 8 Bytes | ## Unsigned version of integer types diff --git a/docs/v0.3/en/reference/sdk/go.md b/docs/v0.3/en/reference/sdk/go.md index 9f4409e10..0b77fe9da 100644 --- a/docs/v0.3/en/reference/sdk/go.md +++ b/docs/v0.3/en/reference/sdk/go.md @@ -11,7 +11,7 @@ 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](/user-guide/clients/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/v0.3/en/reference/sdk/java.md b/docs/v0.3/en/reference/sdk/java.md index 0f73611c2..42daf9130 100644 --- a/docs/v0.3/en/reference/sdk/java.md +++ b/docs/v0.3/en/reference/sdk/java.md @@ -14,7 +14,7 @@ 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](/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). +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) diff --git a/docs/v0.3/en/user-guide/clients/influxdb-line.md b/docs/v0.3/en/user-guide/clients/influxdb-line.md index 39e7c3197..a4d685aef 100644 --- a/docs/v0.3/en/user-guide/clients/influxdb-line.md +++ b/docs/v0.3/en/user-guide/clients/influxdb-line.md @@ -6,7 +6,7 @@ GreptimeDB is compatible with InfluxDB's line protocol authentication format, bo **[V2 protocol](https://docs.influxdata.com/influxdb/v1.8/tools/api/?t=Auth+Enabled#apiv2query-http-endpoint)** -InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protcol. +InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protocol. ```shell ❯ curl 'http://localhost:4000/v1/influxdb/write?db=public' \ diff --git a/docs/v0.3/en/user-guide/cluster.md b/docs/v0.3/en/user-guide/cluster.md index 1016d468c..1215ec7a7 100644 --- a/docs/v0.3/en/user-guide/cluster.md +++ b/docs/v0.3/en/user-guide/cluster.md @@ -2,7 +2,7 @@ ## Create a cluster -Please refer to [Kubernetes](./operations/kubernetes.md) to get the infomation about creating a Kubernetes cluster. +Please refer to [Kubernetes](./operations/kubernetes.md) to get the information about creating a Kubernetes cluster. ## Distributed Read/Write diff --git a/docs/v0.3/en/user-guide/concepts/overview.md b/docs/v0.3/en/user-guide/concepts/overview.md index 5f744f4fd..656d41b76 100644 --- a/docs/v0.3/en/user-guide/concepts/overview.md +++ b/docs/v0.3/en/user-guide/concepts/overview.md @@ -1,6 +1,6 @@ # Overview -- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performence, and user-friendly. +- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performance, and user-friendly. - [Data Model](./data-model.md): This document describes the data model of GreptimeDB, including table schema, index columns, etc. - [Architecture](./architecture.md): Get the cloud-native architecture of GreptimeDB. - [Storage Location](./storage-location.md): This document describes the storage location of GreptimeDB, including local disk, HDFS, and S3. diff --git a/docs/v0.3/en/user-guide/query-data/promql.md b/docs/v0.3/en/user-guide/query-data/promql.md index 568966dd8..62ea4b679 100644 --- a/docs/v0.3/en/user-guide/query-data/promql.md +++ b/docs/v0.3/en/user-guide/query-data/promql.md @@ -115,7 +115,7 @@ The result format is the same as `/sql` interface described in [query data](sql. "execution_time_ms": 5 } ``` - + ## SQL diff --git a/docs/v0.3/en/user-guide/table-management.md b/docs/v0.3/en/user-guide/table-management.md index fba661894..aa5046ae0 100644 --- a/docs/v0.3/en/user-guide/table-management.md +++ b/docs/v0.3/en/user-guide/table-management.md @@ -7,7 +7,7 @@ uses [MySQL Command-Line Client](https://dev.mysql.com/doc/refman/8.0/en/mysql.h ## Create Database -The default database is `public`. You can create a database manully. +The default database is `public`. You can create a database manually. ```sql CREATE DATABASE test; diff --git a/docs/v0.3/zh/reference/data-types.md b/docs/v0.3/zh/reference/data-types.md index 19ee74570..b82e75c78 100644 --- a/docs/v0.3/zh/reference/data-types.md +++ b/docs/v0.3/zh/reference/data-types.md @@ -15,7 +15,7 @@ GreptimeDB 支持下列数据类型： |`varbinary`|Variable length binary values| | The length of the data + 2 bytes| |`date`|32-bit date values|| 4 Bytes | |`datetime`|64-bit datetime values|| 8 Bytes | -|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseonds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|| 8 Bytes | +|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseconds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|| 8 Bytes | ## 整数类型的 Unsigned 版本 diff --git a/docs/v0.3/zh/user-guide/clients/otlp.md b/docs/v0.3/zh/user-guide/clients/otlp.md index b32963495..d0aed2b0a 100644 --- a/docs/v0.3/zh/user-guide/clients/otlp.md +++ b/docs/v0.3/zh/user-guide/clients/otlp.md @@ -79,5 +79,5 @@ OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型 - 所有的 Attribute ，包含 resource 级别、scope 级别和 data_point 级别，都被作为 GreptimeDB 表的 tag 列。 - 数据点的时间戳被作为 GreptimeDB 的时间戳索引，列名 greptime_timestamp。 - Gauge/Sum 两种类型的数据点数据被作为 field 列，列名 greptime_value。 -- Summay 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 +- Summary 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 - Histogram 和 ExponentialHistogram 暂时未被支持，我们可能在后续版本中推出 Histogram 数据类型来原生支持这两种类型。 diff --git a/docs/v0.3/zh/user-guide/query-data/promql.md b/docs/v0.3/zh/user-guide/query-data/promql.md index 0db43526a..725fa4000 100644 --- a/docs/v0.3/zh/user-guide/query-data/promql.md +++ b/docs/v0.3/zh/user-guide/query-data/promql.md @@ -112,7 +112,7 @@ curl -X GET \ "execution_time_ms": 5 } ``` - + ## SQL diff --git a/docs/v0.4/en/db-cloud-shared/quick-start/influxdb.md b/docs/v0.4/en/db-cloud-shared/quick-start/influxdb.md index da2bcf001..febbc41a3 100644 --- a/docs/v0.4/en/db-cloud-shared/quick-start/influxdb.md +++ b/docs/v0.4/en/db-cloud-shared/quick-start/influxdb.md @@ -1,2 +1,2 @@ -To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). +To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). diff --git a/docs/v0.4/en/db-cloud-shared/quick-start/mysql.md b/docs/v0.4/en/db-cloud-shared/quick-start/mysql.md index de5963a6e..f8c8742bc 100644 --- a/docs/v0.4/en/db-cloud-shared/quick-start/mysql.md +++ b/docs/v0.4/en/db-cloud-shared/quick-start/mysql.md @@ -1,3 +1,3 @@ -To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). +To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). diff --git a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md index 0a7e5a920..77a9714a1 100644 --- a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md +++ b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md @@ -11,7 +11,7 @@ go get go.opentelemetry.io/otel@v1.16.0 \ ``` Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB in `app.go`. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```go auth := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", *username, *password))) diff --git a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md index 7b1e28d98..262dce433 100644 --- a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md +++ b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md @@ -21,7 +21,7 @@ dependencies { } ``` -Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```java String endpoint = String.format("https://%s/v1/otlp/v1/metrics", dbHost); diff --git a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md index a751d942b..e66e605f0 100644 --- a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md +++ b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md @@ -25,7 +25,7 @@ npm install @opentelemetry/api@1.4.1 \ ``` Once the required packages are installed,create a new file named `app.ts` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```ts const exporter = new OTLPMetricExporter({ diff --git a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md index 78040946e..3d65280ad 100644 --- a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md +++ b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md @@ -53,7 +53,7 @@ remote_write: password: ``` -The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). +The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configuration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). Finally, start the containers: diff --git a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md index 13baa5147..2be6d8e82 100644 --- a/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md +++ b/docs/v0.4/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md @@ -25,7 +25,7 @@ pip install -r requirements.txt ``` Once the required packages are installed,create a new file named `main.py` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```python from opentelemetry import metrics diff --git a/docs/v0.4/en/developer-guide/frontend/distributed-querying.md b/docs/v0.4/en/developer-guide/frontend/distributed-querying.md index ee86c6ab3..f6f2399da 100644 --- a/docs/v0.4/en/developer-guide/frontend/distributed-querying.md +++ b/docs/v0.4/en/developer-guide/frontend/distributed-querying.md @@ -15,7 +15,7 @@ Planner will traverse the input logical plan, and split it into multiple stages rule](https://github.com/GreptimeTeam/greptimedb/blob/main/docs/rfcs/2023-05-09-distributed-planner.md)". This rule is under heavy development. At present it will consider things like: -- whether the operator ifself is commutative +- whether the operator itself is commutative - how the partition rule is configured - etc... diff --git a/docs/v0.4/en/reference/command-lines.md b/docs/v0.4/en/reference/command-lines.md index c1cd7c313..9f0430938 100644 --- a/docs/v0.4/en/reference/command-lines.md +++ b/docs/v0.4/en/reference/command-lines.md @@ -39,7 +39,7 @@ Starts GreptimeDB in standalone mode with customized configurations: greptime --log-dir=/tmp/greptimedb/logs --log-level=info standalone start -c config/standalone.example.toml ``` -The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuraiton files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). +The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). To start GreptimeDB in distributed mode, you need to start each component separately. The following commands show how to start each component with customized configurations or command line arguments. diff --git a/docs/v0.4/en/reference/data-types.md b/docs/v0.4/en/reference/data-types.md index 64217ae63..eee5dc825 100644 --- a/docs/v0.4/en/reference/data-types.md +++ b/docs/v0.4/en/reference/data-types.md @@ -15,7 +15,7 @@ GreptimeDB supports the following data types: |`varbinary`|Variable length binary values| `Binary`| The length of the data + 2 bytes| |`date`|32-bit date values represent the days since UNIX Epoch |`Date`| 4 Bytes | |`datetime`|64-bit datetime values represent the milliseconds since UNIX Epoch|`DateTime`| 8 Bytes | -|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseonds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|`TimestampSecond`
/`TimestampMillisecond`
/`TimestampMicroSecond`
/`TimestampNanosecond` | 8 Bytes | +|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseconds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|`TimestampSecond`
/`TimestampMillisecond`
/`TimestampMicroSecond`
/`TimestampNanosecond` | 8 Bytes | ## Unsigned version of integer types `int` / `tinyint` / `smallint` / `bigint` also have unsigned version, and there corresponding value ranges are: diff --git a/docs/v0.4/en/reference/sql/range.md b/docs/v0.4/en/reference/sql/range.md index c179cde1a..5c6ae9e47 100644 --- a/docs/v0.4/en/reference/sql/range.md +++ b/docs/v0.4/en/reference/sql/range.md @@ -250,7 +250,7 @@ Suppose we have a tale `host` with the following data: +---------------------+-------+------+ ``` -The following SQL uses `host` as the aggragate key: +The following SQL uses `host` as the aggregate key: ```sql SELECT diff --git a/docs/v0.4/en/user-guide/clients/influxdb-line.md b/docs/v0.4/en/user-guide/clients/influxdb-line.md index a3658db3d..4cb94d5e4 100644 --- a/docs/v0.4/en/user-guide/clients/influxdb-line.md +++ b/docs/v0.4/en/user-guide/clients/influxdb-line.md @@ -6,7 +6,7 @@ GreptimeDB is compatible with InfluxDB's line protocol authentication format, bo **[V2 protocol](https://docs.influxdata.com/influxdb/v1.8/tools/api/?t=Auth+Enabled#apiv2query-http-endpoint)** -InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protcol. +InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protocol. ```shell ❯ curl 'http://localhost:4000/v1/influxdb/api/v2/write?db=public' \ diff --git a/docs/v0.4/en/user-guide/cluster.md b/docs/v0.4/en/user-guide/cluster.md index e5e651390..788cee965 100644 --- a/docs/v0.4/en/user-guide/cluster.md +++ b/docs/v0.4/en/user-guide/cluster.md @@ -2,7 +2,7 @@ ## Create a cluster -Please refer to [Kubernetes](./operations/kubernetes.md) to get the infomation about creating a Kubernetes cluster. +Please refer to [Kubernetes](./operations/kubernetes.md) to get the information about creating a Kubernetes cluster. ## Distributed Read/Write diff --git a/docs/v0.4/en/user-guide/concepts/overview.md b/docs/v0.4/en/user-guide/concepts/overview.md index c17bda840..bee3c88bf 100644 --- a/docs/v0.4/en/user-guide/concepts/overview.md +++ b/docs/v0.4/en/user-guide/concepts/overview.md @@ -1,6 +1,6 @@ # Overview -- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performence, and user-friendly. +- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performance, and user-friendly. - [Data Model](./data-model.md): This document describes the data model of GreptimeDB, including table schema, index columns, etc. - [Architecture](./architecture.md): Get the cloud-native architecture of GreptimeDB. - [Storage Location](./storage-location.md): This document describes the storage location of GreptimeDB, including local disk, HDFS, and cloud object storage such as S3, Azure Blob Storage, etc. diff --git a/docs/v0.4/en/user-guide/operations/configuration.md b/docs/v0.4/en/user-guide/operations/configuration.md index a25815e5e..407527089 100644 --- a/docs/v0.4/en/user-guide/operations/configuration.md +++ b/docs/v0.4/en/user-guide/operations/configuration.md @@ -61,7 +61,7 @@ greptime metasrv start --help - `--http-timeout `: HTTP request timeout in seconds. - `--selector `: You can refer [selector-type](/developer-guide/metasrv/selector#selector-type); - `--server-addr `: The communication server address for frontend and datanode to connect to metasrv; -- `--store-addr `: Comma seperated etcd server addresses to store metadata; +- `--store-addr `: Comma separated etcd server addresses to store metadata; - `--use-memory-store`: Use memory store instead of etcd, for test purpose only; ### Frontend subcommand options diff --git a/docs/v0.4/en/user-guide/operations/monitoring.md b/docs/v0.4/en/user-guide/operations/monitoring.md index c3823c2c6..4ef7a8740 100644 --- a/docs/v0.4/en/user-guide/operations/monitoring.md +++ b/docs/v0.4/en/user-guide/operations/monitoring.md @@ -2,7 +2,7 @@ The GreptimeDB exposes the Prometheus metrics, and the users can also use [Prometheus](https://prometheus.io/) to collect the metrics. -## Promethues Configuration +## Prometheus Configuration Write a Prometheus configuration file and save it as `prometheus.yml`: ``` diff --git a/docs/v0.4/en/user-guide/query-data/promql.md b/docs/v0.4/en/user-guide/query-data/promql.md index 1fb5e5137..a17f11cc8 100644 --- a/docs/v0.4/en/user-guide/query-data/promql.md +++ b/docs/v0.4/en/user-guide/query-data/promql.md @@ -115,7 +115,7 @@ The result format is the same as `/sql` interface described in [query data](sql. "execution_time_ms": 5 } ``` - + ## SQL diff --git a/docs/v0.4/en/user-guide/scripts-&-functions/getting-started.md b/docs/v0.4/en/user-guide/scripts-&-functions/getting-started.md index dd5e3a5cf..51803db23 100644 --- a/docs/v0.4/en/user-guide/scripts-&-functions/getting-started.md +++ b/docs/v0.4/en/user-guide/scripts-&-functions/getting-started.md @@ -14,7 +14,7 @@ conda create --name Greptime python= For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseonds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|`TimestampSecond`
/`TimestampMillisecond`
/`TimestampMicroSecond`
/`TimestampNanosecond` | 8 Bytes | +|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseconds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|`TimestampSecond`
/`TimestampMillisecond`
/`TimestampMicroSecond`
/`TimestampNanosecond` | 8 Bytes | ## 整数类型的 Unsigned 版本 diff --git a/docs/v0.4/zh/user-guide/clients/otlp.md b/docs/v0.4/zh/user-guide/clients/otlp.md index b32963495..d0aed2b0a 100644 --- a/docs/v0.4/zh/user-guide/clients/otlp.md +++ b/docs/v0.4/zh/user-guide/clients/otlp.md @@ -79,5 +79,5 @@ OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型 - 所有的 Attribute ，包含 resource 级别、scope 级别和 data_point 级别，都被作为 GreptimeDB 表的 tag 列。 - 数据点的时间戳被作为 GreptimeDB 的时间戳索引，列名 greptime_timestamp。 - Gauge/Sum 两种类型的数据点数据被作为 field 列，列名 greptime_value。 -- Summay 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 +- Summary 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 - Histogram 和 ExponentialHistogram 暂时未被支持，我们可能在后续版本中推出 Histogram 数据类型来原生支持这两种类型。 diff --git a/docs/v0.4/zh/user-guide/operations/monitoring.md b/docs/v0.4/zh/user-guide/operations/monitoring.md index 927dd91a4..1403eeaa4 100644 --- a/docs/v0.4/zh/user-guide/operations/monitoring.md +++ b/docs/v0.4/zh/user-guide/operations/monitoring.md @@ -2,7 +2,7 @@ GreptimeDB 暴露了 Prometheus 指标, 用户可以使用 [Prometheus](https://prometheus.io/) 来采集指标。 -## Promethues Configuration +## Prometheus Configuration 编写 Prometheus 配置文件，并保存为`prometheus.yml`: ``` diff --git a/docs/v0.4/zh/user-guide/query-data/promql.md b/docs/v0.4/zh/user-guide/query-data/promql.md index c906f488e..26d9244f2 100644 --- a/docs/v0.4/zh/user-guide/query-data/promql.md +++ b/docs/v0.4/zh/user-guide/query-data/promql.md @@ -112,7 +112,7 @@ curl -X GET \ "execution_time_ms": 5 } ``` - + ## SQL diff --git a/docs/v0.5/en/contributor-guide/frontend/distributed-querying.md b/docs/v0.5/en/contributor-guide/frontend/distributed-querying.md index ee86c6ab3..f6f2399da 100644 --- a/docs/v0.5/en/contributor-guide/frontend/distributed-querying.md +++ b/docs/v0.5/en/contributor-guide/frontend/distributed-querying.md @@ -15,7 +15,7 @@ Planner will traverse the input logical plan, and split it into multiple stages rule](https://github.com/GreptimeTeam/greptimedb/blob/main/docs/rfcs/2023-05-09-distributed-planner.md)". This rule is under heavy development. At present it will consider things like: -- whether the operator ifself is commutative +- whether the operator itself is commutative - how the partition rule is configured - etc... diff --git a/docs/v0.5/en/db-cloud-shared/quick-start/influxdb.md b/docs/v0.5/en/db-cloud-shared/quick-start/influxdb.md index da2bcf001..febbc41a3 100644 --- a/docs/v0.5/en/db-cloud-shared/quick-start/influxdb.md +++ b/docs/v0.5/en/db-cloud-shared/quick-start/influxdb.md @@ -1,2 +1,2 @@ -To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). +To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). diff --git a/docs/v0.5/en/db-cloud-shared/quick-start/mysql.md b/docs/v0.5/en/db-cloud-shared/quick-start/mysql.md index de5963a6e..f8c8742bc 100644 --- a/docs/v0.5/en/db-cloud-shared/quick-start/mysql.md +++ b/docs/v0.5/en/db-cloud-shared/quick-start/mysql.md @@ -1,3 +1,3 @@ -To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). +To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). diff --git a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md index 0a7e5a920..77a9714a1 100644 --- a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md +++ b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md @@ -11,7 +11,7 @@ go get go.opentelemetry.io/otel@v1.16.0 \ ``` Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB in `app.go`. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```go auth := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", *username, *password))) diff --git a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md index 7b1e28d98..262dce433 100644 --- a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md +++ b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md @@ -21,7 +21,7 @@ dependencies { } ``` -Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```java String endpoint = String.format("https://%s/v1/otlp/v1/metrics", dbHost); diff --git a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md index a751d942b..e66e605f0 100644 --- a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md +++ b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md @@ -25,7 +25,7 @@ npm install @opentelemetry/api@1.4.1 \ ``` Once the required packages are installed,create a new file named `app.ts` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```ts const exporter = new OTLPMetricExporter({ diff --git a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md index 78040946e..3d65280ad 100644 --- a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md +++ b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md @@ -53,7 +53,7 @@ remote_write: password: ``` -The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). +The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configuration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). Finally, start the containers: diff --git a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md index 13baa5147..2be6d8e82 100644 --- a/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md +++ b/docs/v0.5/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md @@ -25,7 +25,7 @@ pip install -r requirements.txt ``` Once the required packages are installed,create a new file named `main.py` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```python from opentelemetry import metrics diff --git a/docs/v0.5/en/reference/command-lines.md b/docs/v0.5/en/reference/command-lines.md index c1cd7c313..9f0430938 100644 --- a/docs/v0.5/en/reference/command-lines.md +++ b/docs/v0.5/en/reference/command-lines.md @@ -39,7 +39,7 @@ Starts GreptimeDB in standalone mode with customized configurations: greptime --log-dir=/tmp/greptimedb/logs --log-level=info standalone start -c config/standalone.example.toml ``` -The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuraiton files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). +The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). To start GreptimeDB in distributed mode, you need to start each component separately. The following commands show how to start each component with customized configurations or command line arguments. diff --git a/docs/v0.5/en/reference/data-types.md b/docs/v0.5/en/reference/data-types.md index 64217ae63..eee5dc825 100644 --- a/docs/v0.5/en/reference/data-types.md +++ b/docs/v0.5/en/reference/data-types.md @@ -15,7 +15,7 @@ GreptimeDB supports the following data types: |`varbinary`|Variable length binary values| `Binary`| The length of the data + 2 bytes| |`date`|32-bit date values represent the days since UNIX Epoch |`Date`| 4 Bytes | |`datetime`|64-bit datetime values represent the milliseconds since UNIX Epoch|`DateTime`| 8 Bytes | -|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseonds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|`TimestampSecond`
/`TimestampMillisecond`
/`TimestampMicroSecond`
/`TimestampNanosecond` | 8 Bytes | +|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseconds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|`TimestampSecond`
/`TimestampMillisecond`
/`TimestampMicroSecond`
/`TimestampNanosecond` | 8 Bytes | ## Unsigned version of integer types `int` / `tinyint` / `smallint` / `bigint` also have unsigned version, and there corresponding value ranges are: diff --git a/docs/v0.5/en/reference/sql/range.md b/docs/v0.5/en/reference/sql/range.md index c179cde1a..5c6ae9e47 100644 --- a/docs/v0.5/en/reference/sql/range.md +++ b/docs/v0.5/en/reference/sql/range.md @@ -250,7 +250,7 @@ Suppose we have a tale `host` with the following data: +---------------------+-------+------+ ``` -The following SQL uses `host` as the aggragate key: +The following SQL uses `host` as the aggregate key: ```sql SELECT diff --git a/docs/v0.5/en/user-guide/client-libraries/java.md b/docs/v0.5/en/user-guide/client-libraries/java.md index b971589ce..6f9ea8867 100644 --- a/docs/v0.5/en/user-guide/client-libraries/java.md +++ b/docs/v0.5/en/user-guide/client-libraries/java.md @@ -313,7 +313,7 @@ For fully runnable code snippets and explanations for common methods, see the [E Java database connectivity (JDBC) is the JavaSoft specification of a standard application programming interface (API) that allows Java programs to access database management systems. Many databases, such as MySQL or PostgreSQL, have implemented their own drivers based on the JDBC API. -Since GreptimeDB supports [mutiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC. +Since GreptimeDB supports [multiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC. If you want to use other protocols, just replace the MySQL driver with the corresponding driver. %} diff --git a/docs/v0.5/en/user-guide/clients/influxdb-line.md b/docs/v0.5/en/user-guide/clients/influxdb-line.md index a3658db3d..4cb94d5e4 100644 --- a/docs/v0.5/en/user-guide/clients/influxdb-line.md +++ b/docs/v0.5/en/user-guide/clients/influxdb-line.md @@ -6,7 +6,7 @@ GreptimeDB is compatible with InfluxDB's line protocol authentication format, bo **[V2 protocol](https://docs.influxdata.com/influxdb/v1.8/tools/api/?t=Auth+Enabled#apiv2query-http-endpoint)** -InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protcol. +InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protocol. ```shell ❯ curl 'http://localhost:4000/v1/influxdb/api/v2/write?db=public' \ diff --git a/docs/v0.5/en/user-guide/cluster.md b/docs/v0.5/en/user-guide/cluster.md index c4f7f2f67..b96fc8ae8 100644 --- a/docs/v0.5/en/user-guide/cluster.md +++ b/docs/v0.5/en/user-guide/cluster.md @@ -2,7 +2,7 @@ ## Create a cluster -Please refer to [Kubernetes](./operations/kubernetes.md) to get the infomation about creating a Kubernetes cluster. +Please refer to [Kubernetes](./operations/kubernetes.md) to get the information about creating a Kubernetes cluster. ## Distributed Read/Write diff --git a/docs/v0.5/en/user-guide/concepts/overview.md b/docs/v0.5/en/user-guide/concepts/overview.md index c17bda840..bee3c88bf 100644 --- a/docs/v0.5/en/user-guide/concepts/overview.md +++ b/docs/v0.5/en/user-guide/concepts/overview.md @@ -1,6 +1,6 @@ # Overview -- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performence, and user-friendly. +- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performance, and user-friendly. - [Data Model](./data-model.md): This document describes the data model of GreptimeDB, including table schema, index columns, etc. - [Architecture](./architecture.md): Get the cloud-native architecture of GreptimeDB. - [Storage Location](./storage-location.md): This document describes the storage location of GreptimeDB, including local disk, HDFS, and cloud object storage such as S3, Azure Blob Storage, etc. diff --git a/docs/v0.5/en/user-guide/operations/configuration.md b/docs/v0.5/en/user-guide/operations/configuration.md index 424f0d577..0c287e7e7 100644 --- a/docs/v0.5/en/user-guide/operations/configuration.md +++ b/docs/v0.5/en/user-guide/operations/configuration.md @@ -61,7 +61,7 @@ greptime metasrv start --help - `--http-timeout `: HTTP request timeout in seconds. - `--selector `: You can refer [selector-type](/contributor-guide/metasrv/selector#selector-type); - `--server-addr `: The communication server address for frontend and datanode to connect to metasrv; -- `--store-addr `: Comma seperated etcd server addresses to store metadata; +- `--store-addr `: Comma separated etcd server addresses to store metadata; - `--use-memory-store`: Use memory store instead of etcd, for test purpose only; ### Frontend subcommand options diff --git a/docs/v0.5/en/user-guide/operations/monitoring.md b/docs/v0.5/en/user-guide/operations/monitoring.md index c3823c2c6..4ef7a8740 100644 --- a/docs/v0.5/en/user-guide/operations/monitoring.md +++ b/docs/v0.5/en/user-guide/operations/monitoring.md @@ -2,7 +2,7 @@ The GreptimeDB exposes the Prometheus metrics, and the users can also use [Prometheus](https://prometheus.io/) to collect the metrics. -## Promethues Configuration +## Prometheus Configuration Write a Prometheus configuration file and save it as `prometheus.yml`: ``` diff --git a/docs/v0.5/en/user-guide/python-scripts/getting-started.md b/docs/v0.5/en/user-guide/python-scripts/getting-started.md index 5c1ea263b..c41654a5d 100644 --- a/docs/v0.5/en/user-guide/python-scripts/getting-started.md +++ b/docs/v0.5/en/user-guide/python-scripts/getting-started.md @@ -14,7 +14,7 @@ conda create --name Greptime python= + ## SQL diff --git a/docs/v0.5/en/user-guide/table-management.md b/docs/v0.5/en/user-guide/table-management.md index 415a91d50..9d69f25fe 100644 --- a/docs/v0.5/en/user-guide/table-management.md +++ b/docs/v0.5/en/user-guide/table-management.md @@ -9,7 +9,7 @@ For more explanations of the `SQL` syntax, please see the [SQL reference](/refer ## Create Database -The default database is `public`. You can create a database manully. +The default database is `public`. You can create a database manually. ```sql CREATE DATABASE test; diff --git a/docs/v0.5/zh/reference/data-types.md b/docs/v0.5/zh/reference/data-types.md index 08838f6b7..0c9618410 100644 --- a/docs/v0.5/zh/reference/data-types.md +++ b/docs/v0.5/zh/reference/data-types.md @@ -15,7 +15,7 @@ GreptimeDB 支持下列数据类型： |`varbinary`|Variable length binary values| `Binary`| The length of the data + 2 bytes| |`date`|32-bit date values represent the days since UNIX Epoch |`Date`| 4 Bytes | |`datetime`|64-bit datetime values represent the milliseconds since UNIX Epoch|`DateTime`| 8 Bytes | -|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseonds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|`TimestampSecond`
/`TimestampMillisecond`
/`TimestampMicroSecond`
/`TimestampNanosecond` | 8 Bytes | +|`timestamp[(0/3/6/9)]`|64-bit timestamp values with optional precision.
For example, `timestamp(0)` represents timestamp type with seconds precision, `timestamp(3)` represents milliseconds precision, `timestamp(6)` for microseconds and `timestamp(9)` for nanoseconds. If no precision is given, the timestamp is in **milliseconds** precision by default.|`TimestampSecond`
/`TimestampMillisecond`
/`TimestampMicroSecond`
/`TimestampNanosecond` | 8 Bytes | ## 整数类型的 Unsigned 版本 diff --git a/docs/v0.5/zh/user-guide/clients/otlp.md b/docs/v0.5/zh/user-guide/clients/otlp.md index b32963495..d0aed2b0a 100644 --- a/docs/v0.5/zh/user-guide/clients/otlp.md +++ b/docs/v0.5/zh/user-guide/clients/otlp.md @@ -79,5 +79,5 @@ OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型 - 所有的 Attribute ，包含 resource 级别、scope 级别和 data_point 级别，都被作为 GreptimeDB 表的 tag 列。 - 数据点的时间戳被作为 GreptimeDB 的时间戳索引，列名 greptime_timestamp。 - Gauge/Sum 两种类型的数据点数据被作为 field 列，列名 greptime_value。 -- Summay 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 +- Summary 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 - Histogram 和 ExponentialHistogram 暂时未被支持，我们可能在后续版本中推出 Histogram 数据类型来原生支持这两种类型。 diff --git a/docs/v0.5/zh/user-guide/operations/monitoring.md b/docs/v0.5/zh/user-guide/operations/monitoring.md index 927dd91a4..1403eeaa4 100644 --- a/docs/v0.5/zh/user-guide/operations/monitoring.md +++ b/docs/v0.5/zh/user-guide/operations/monitoring.md @@ -2,7 +2,7 @@ GreptimeDB 暴露了 Prometheus 指标, 用户可以使用 [Prometheus](https://prometheus.io/) 来采集指标。 -## Promethues Configuration +## Prometheus Configuration 编写 Prometheus 配置文件，并保存为`prometheus.yml`: ``` diff --git a/docs/v0.5/zh/user-guide/query-data/promql.md b/docs/v0.5/zh/user-guide/query-data/promql.md index c906f488e..26d9244f2 100644 --- a/docs/v0.5/zh/user-guide/query-data/promql.md +++ b/docs/v0.5/zh/user-guide/query-data/promql.md @@ -112,7 +112,7 @@ curl -X GET \ "execution_time_ms": 5 } ``` - + ## SQL diff --git a/docs/v0.6/en/contributor-guide/frontend/distributed-querying.md b/docs/v0.6/en/contributor-guide/frontend/distributed-querying.md index ee86c6ab3..f6f2399da 100644 --- a/docs/v0.6/en/contributor-guide/frontend/distributed-querying.md +++ b/docs/v0.6/en/contributor-guide/frontend/distributed-querying.md @@ -15,7 +15,7 @@ Planner will traverse the input logical plan, and split it into multiple stages rule](https://github.com/GreptimeTeam/greptimedb/blob/main/docs/rfcs/2023-05-09-distributed-planner.md)". This rule is under heavy development. At present it will consider things like: -- whether the operator ifself is commutative +- whether the operator itself is commutative - how the partition rule is configured - etc... diff --git a/docs/v0.6/en/db-cloud-shared/quick-start/influxdb.md b/docs/v0.6/en/db-cloud-shared/quick-start/influxdb.md index da2bcf001..febbc41a3 100644 --- a/docs/v0.6/en/db-cloud-shared/quick-start/influxdb.md +++ b/docs/v0.6/en/db-cloud-shared/quick-start/influxdb.md @@ -1,2 +1,2 @@ -To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). +To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). diff --git a/docs/v0.6/en/db-cloud-shared/quick-start/mysql.md b/docs/v0.6/en/db-cloud-shared/quick-start/mysql.md index de5963a6e..f8c8742bc 100644 --- a/docs/v0.6/en/db-cloud-shared/quick-start/mysql.md +++ b/docs/v0.6/en/db-cloud-shared/quick-start/mysql.md @@ -1,3 +1,3 @@ -To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). +To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). diff --git a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md index 0a7e5a920..77a9714a1 100644 --- a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md +++ b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md @@ -11,7 +11,7 @@ go get go.opentelemetry.io/otel@v1.16.0 \ ``` Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB in `app.go`. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```go auth := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", *username, *password))) diff --git a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md index 7b1e28d98..262dce433 100644 --- a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md +++ b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md @@ -21,7 +21,7 @@ dependencies { } ``` -Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```java String endpoint = String.format("https://%s/v1/otlp/v1/metrics", dbHost); diff --git a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md index a751d942b..e66e605f0 100644 --- a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md +++ b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md @@ -25,7 +25,7 @@ npm install @opentelemetry/api@1.4.1 \ ``` Once the required packages are installed,create a new file named `app.ts` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```ts const exporter = new OTLPMetricExporter({ diff --git a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md index 78040946e..3d65280ad 100644 --- a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md +++ b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md @@ -53,7 +53,7 @@ remote_write: password: ``` -The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). +The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configuration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). Finally, start the containers: diff --git a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md index 13baa5147..2be6d8e82 100644 --- a/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md +++ b/docs/v0.6/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md @@ -25,7 +25,7 @@ pip install -r requirements.txt ``` Once the required packages are installed,create a new file named `main.py` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```python from opentelemetry import metrics diff --git a/docs/v0.6/en/getting-started/installation/greptimedb-dashboard.md b/docs/v0.6/en/getting-started/installation/greptimedb-dashboard.md index 020285c1f..d62571223 100644 --- a/docs/v0.6/en/getting-started/installation/greptimedb-dashboard.md +++ b/docs/v0.6/en/getting-started/installation/greptimedb-dashboard.md @@ -2,7 +2,7 @@ Visualization plays a crucial role in effectively utilizing time series data. To help users leverage the various features of GreptimeDB, Greptime offers a simple [dashboard](https://github.com/GreptimeTeam/dashboard). -The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports mutiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md). +The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports multiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md). We offer various chart types to choose from based on different scenarios. The charts become more informative when you have sufficient data. diff --git a/docs/v0.6/en/reference/command-lines.md b/docs/v0.6/en/reference/command-lines.md index c1cd7c313..9f0430938 100644 --- a/docs/v0.6/en/reference/command-lines.md +++ b/docs/v0.6/en/reference/command-lines.md @@ -39,7 +39,7 @@ Starts GreptimeDB in standalone mode with customized configurations: greptime --log-dir=/tmp/greptimedb/logs --log-level=info standalone start -c config/standalone.example.toml ``` -The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuraiton files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). +The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). To start GreptimeDB in distributed mode, you need to start each component separately. The following commands show how to start each component with customized configurations or command line arguments. diff --git a/docs/v0.6/en/reference/sql/copy.md b/docs/v0.6/en/reference/sql/copy.md index 29145d0f5..152077bc5 100644 --- a/docs/v0.6/en/reference/sql/copy.md +++ b/docs/v0.6/en/reference/sql/copy.md @@ -144,7 +144,7 @@ COPY DATABASE | `FORMAT` | Export file format, available options: JSON, CSV, Parquet | **Required** | | `START_TIME`/`END_TIME`| The time range within which data should be exported. `START_TIME` is inclusive and `END_TIME` is exclusive. | Optional | -> - When copying databses, `` must end with `/`. +> - When copying databases, `` must end with `/`. > - `CONNECTION` parameters can also be used to copying databases to/from object storage services like AWS S3. ### Examples diff --git a/docs/v0.6/en/reference/sql/range.md b/docs/v0.6/en/reference/sql/range.md index c179cde1a..5c6ae9e47 100644 --- a/docs/v0.6/en/reference/sql/range.md +++ b/docs/v0.6/en/reference/sql/range.md @@ -250,7 +250,7 @@ Suppose we have a tale `host` with the following data: +---------------------+-------+------+ ``` -The following SQL uses `host` as the aggragate key: +The following SQL uses `host` as the aggregate key: ```sql SELECT diff --git a/docs/v0.6/en/user-guide/client-libraries/java.md b/docs/v0.6/en/user-guide/client-libraries/java.md index 15290ba5f..d009ce66e 100644 --- a/docs/v0.6/en/user-guide/client-libraries/java.md +++ b/docs/v0.6/en/user-guide/client-libraries/java.md @@ -385,7 +385,7 @@ For fully runnable code snippets and the complete code of the demo, please refer Java database connectivity (JDBC) is the JavaSoft specification of a standard application programming interface (API) that allows Java programs to access database management systems. Many databases, such as MySQL or PostgreSQL, have implemented their own drivers based on the JDBC API. -Since GreptimeDB supports [mutiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC. +Since GreptimeDB supports [multiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC. If you want to use other protocols, just replace the MySQL driver with the corresponding driver. %} diff --git a/docs/v0.6/en/user-guide/clients/influxdb-line.md b/docs/v0.6/en/user-guide/clients/influxdb-line.md index a3658db3d..4cb94d5e4 100644 --- a/docs/v0.6/en/user-guide/clients/influxdb-line.md +++ b/docs/v0.6/en/user-guide/clients/influxdb-line.md @@ -6,7 +6,7 @@ GreptimeDB is compatible with InfluxDB's line protocol authentication format, bo **[V2 protocol](https://docs.influxdata.com/influxdb/v1.8/tools/api/?t=Auth+Enabled#apiv2query-http-endpoint)** -InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protcol. +InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protocol. ```shell ❯ curl 'http://localhost:4000/v1/influxdb/api/v2/write?db=public' \ diff --git a/docs/v0.6/en/user-guide/cluster.md b/docs/v0.6/en/user-guide/cluster.md index c4f7f2f67..b96fc8ae8 100644 --- a/docs/v0.6/en/user-guide/cluster.md +++ b/docs/v0.6/en/user-guide/cluster.md @@ -2,7 +2,7 @@ ## Create a cluster -Please refer to [Kubernetes](./operations/kubernetes.md) to get the infomation about creating a Kubernetes cluster. +Please refer to [Kubernetes](./operations/kubernetes.md) to get the information about creating a Kubernetes cluster. ## Distributed Read/Write diff --git a/docs/v0.6/en/user-guide/concepts/overview.md b/docs/v0.6/en/user-guide/concepts/overview.md index c17bda840..bee3c88bf 100644 --- a/docs/v0.6/en/user-guide/concepts/overview.md +++ b/docs/v0.6/en/user-guide/concepts/overview.md @@ -1,6 +1,6 @@ # Overview -- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performence, and user-friendly. +- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performance, and user-friendly. - [Data Model](./data-model.md): This document describes the data model of GreptimeDB, including table schema, index columns, etc. - [Architecture](./architecture.md): Get the cloud-native architecture of GreptimeDB. - [Storage Location](./storage-location.md): This document describes the storage location of GreptimeDB, including local disk, HDFS, and cloud object storage such as S3, Azure Blob Storage, etc. diff --git a/docs/v0.6/en/user-guide/operations/configuration.md b/docs/v0.6/en/user-guide/operations/configuration.md index 460c22c1c..8aeaad617 100644 --- a/docs/v0.6/en/user-guide/operations/configuration.md +++ b/docs/v0.6/en/user-guide/operations/configuration.md @@ -61,7 +61,7 @@ greptime metasrv start --help - `--http-timeout `: HTTP request timeout in seconds. - `--selector `: You can refer [selector-type](/contributor-guide/metasrv/selector#selector-type); - `--server-addr `: The communication server address for frontend and datanode to connect to metasrv; -- `--store-addr `: Comma seperated etcd server addresses to store metadata; +- `--store-addr `: Comma separated etcd server addresses to store metadata; - `--use-memory-store`: Use memory store instead of etcd, for test purpose only; ### Frontend subcommand options diff --git a/docs/v0.6/en/user-guide/python-scripts/getting-started.md b/docs/v0.6/en/user-guide/python-scripts/getting-started.md index 5c1ea263b..c41654a5d 100644 --- a/docs/v0.6/en/user-guide/python-scripts/getting-started.md +++ b/docs/v0.6/en/user-guide/python-scripts/getting-started.md @@ -14,7 +14,7 @@ conda create --name Greptime python= + ## SQL diff --git a/docs/v0.6/en/user-guide/table-management.md b/docs/v0.6/en/user-guide/table-management.md index 8b512189a..9c32c65f3 100644 --- a/docs/v0.6/en/user-guide/table-management.md +++ b/docs/v0.6/en/user-guide/table-management.md @@ -9,7 +9,7 @@ For more explanations of the `SQL` syntax, please see the [SQL reference](/refer ## Create Database -The default database is `public`. You can create a database manully. +The default database is `public`. You can create a database manually. ```sql CREATE DATABASE test; diff --git a/docs/v0.6/zh/user-guide/clients/otlp.md b/docs/v0.6/zh/user-guide/clients/otlp.md index b32963495..d0aed2b0a 100644 --- a/docs/v0.6/zh/user-guide/clients/otlp.md +++ b/docs/v0.6/zh/user-guide/clients/otlp.md @@ -79,5 +79,5 @@ OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型 - 所有的 Attribute ，包含 resource 级别、scope 级别和 data_point 级别，都被作为 GreptimeDB 表的 tag 列。 - 数据点的时间戳被作为 GreptimeDB 的时间戳索引，列名 greptime_timestamp。 - Gauge/Sum 两种类型的数据点数据被作为 field 列，列名 greptime_value。 -- Summay 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 +- Summary 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 - Histogram 和 ExponentialHistogram 暂时未被支持，我们可能在后续版本中推出 Histogram 数据类型来原生支持这两种类型。 diff --git a/docs/v0.6/zh/user-guide/query-data/promql.md b/docs/v0.6/zh/user-guide/query-data/promql.md index c906f488e..26d9244f2 100644 --- a/docs/v0.6/zh/user-guide/query-data/promql.md +++ b/docs/v0.6/zh/user-guide/query-data/promql.md @@ -112,7 +112,7 @@ curl -X GET \ "execution_time_ms": 5 } ``` - + ## SQL diff --git a/docs/v0.7/en/contributor-guide/frontend/distributed-querying.md b/docs/v0.7/en/contributor-guide/frontend/distributed-querying.md index ee86c6ab3..f6f2399da 100644 --- a/docs/v0.7/en/contributor-guide/frontend/distributed-querying.md +++ b/docs/v0.7/en/contributor-guide/frontend/distributed-querying.md @@ -15,7 +15,7 @@ Planner will traverse the input logical plan, and split it into multiple stages rule](https://github.com/GreptimeTeam/greptimedb/blob/main/docs/rfcs/2023-05-09-distributed-planner.md)". This rule is under heavy development. At present it will consider things like: -- whether the operator ifself is commutative +- whether the operator itself is commutative - how the partition rule is configured - etc... diff --git a/docs/v0.7/en/db-cloud-shared/quick-start/influxdb.md b/docs/v0.7/en/db-cloud-shared/quick-start/influxdb.md index da2bcf001..febbc41a3 100644 --- a/docs/v0.7/en/db-cloud-shared/quick-start/influxdb.md +++ b/docs/v0.7/en/db-cloud-shared/quick-start/influxdb.md @@ -1,2 +1,2 @@ -To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). +To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol). diff --git a/docs/v0.7/en/db-cloud-shared/quick-start/mysql.md b/docs/v0.7/en/db-cloud-shared/quick-start/mysql.md index de5963a6e..f8c8742bc 100644 --- a/docs/v0.7/en/db-cloud-shared/quick-start/mysql.md +++ b/docs/v0.7/en/db-cloud-shared/quick-start/mysql.md @@ -1,3 +1,3 @@ -To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). +To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql). diff --git a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md index 0a7e5a920..77a9714a1 100644 --- a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md +++ b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md @@ -11,7 +11,7 @@ go get go.opentelemetry.io/otel@v1.16.0 \ ``` Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB in `app.go`. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```go auth := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", *username, *password))) diff --git a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md index 7b1e28d98..262dce433 100644 --- a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md +++ b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md @@ -21,7 +21,7 @@ dependencies { } ``` -Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```java String endpoint = String.format("https://%s/v1/otlp/v1/metrics", dbHost); diff --git a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md index a751d942b..e66e605f0 100644 --- a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md +++ b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md @@ -25,7 +25,7 @@ npm install @opentelemetry/api@1.4.1 \ ``` Once the required packages are installed,create a new file named `app.ts` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```ts const exporter = new OTLPMetricExporter({ diff --git a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md index 78040946e..3d65280ad 100644 --- a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md +++ b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md @@ -53,7 +53,7 @@ remote_write: password: ``` -The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). +The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configuration about ``, ``, ``, and ``, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md). Finally, start the containers: diff --git a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md index 13baa5147..2be6d8e82 100644 --- a/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md +++ b/docs/v0.7/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md @@ -25,7 +25,7 @@ pip install -r requirements.txt ``` Once the required packages are installed,create a new file named `main.py` and write the code to create a metric export object that sends metrics to GreptimeDB. -For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). +For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md). ```python from opentelemetry import metrics diff --git a/docs/v0.7/en/getting-started/installation/greptimedb-dashboard.md b/docs/v0.7/en/getting-started/installation/greptimedb-dashboard.md index 020285c1f..d62571223 100644 --- a/docs/v0.7/en/getting-started/installation/greptimedb-dashboard.md +++ b/docs/v0.7/en/getting-started/installation/greptimedb-dashboard.md @@ -2,7 +2,7 @@ Visualization plays a crucial role in effectively utilizing time series data. To help users leverage the various features of GreptimeDB, Greptime offers a simple [dashboard](https://github.com/GreptimeTeam/dashboard). -The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports mutiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md). +The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports multiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md). We offer various chart types to choose from based on different scenarios. The charts become more informative when you have sufficient data. diff --git a/docs/v0.7/en/reference/command-lines.md b/docs/v0.7/en/reference/command-lines.md index c1cd7c313..9f0430938 100644 --- a/docs/v0.7/en/reference/command-lines.md +++ b/docs/v0.7/en/reference/command-lines.md @@ -39,7 +39,7 @@ Starts GreptimeDB in standalone mode with customized configurations: greptime --log-dir=/tmp/greptimedb/logs --log-level=info standalone start -c config/standalone.example.toml ``` -The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuraiton files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). +The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md). To start GreptimeDB in distributed mode, you need to start each component separately. The following commands show how to start each component with customized configurations or command line arguments. diff --git a/docs/v0.7/en/reference/sql/copy.md b/docs/v0.7/en/reference/sql/copy.md index 29145d0f5..152077bc5 100644 --- a/docs/v0.7/en/reference/sql/copy.md +++ b/docs/v0.7/en/reference/sql/copy.md @@ -144,7 +144,7 @@ COPY DATABASE | `FORMAT` | Export file format, available options: JSON, CSV, Parquet | **Required** | | `START_TIME`/`END_TIME`| The time range within which data should be exported. `START_TIME` is inclusive and `END_TIME` is exclusive. | Optional | -> - When copying databses, `` must end with `/`. +> - When copying databases, `` must end with `/`. > - `CONNECTION` parameters can also be used to copying databases to/from object storage services like AWS S3. ### Examples diff --git a/docs/v0.7/en/reference/sql/range.md b/docs/v0.7/en/reference/sql/range.md index df71773ed..c2bdceb48 100644 --- a/docs/v0.7/en/reference/sql/range.md +++ b/docs/v0.7/en/reference/sql/range.md @@ -322,7 +322,7 @@ Suppose we have a tale `host` with the following data: +---------------------+-------+------+ ``` -The following SQL uses `host` as the aggragate key: +The following SQL uses `host` as the aggregate key: ```sql SELECT diff --git a/docs/v0.7/en/user-guide/client-libraries/java.md b/docs/v0.7/en/user-guide/client-libraries/java.md index 9c510556b..ecb023b3b 100644 --- a/docs/v0.7/en/user-guide/client-libraries/java.md +++ b/docs/v0.7/en/user-guide/client-libraries/java.md @@ -387,7 +387,7 @@ For fully runnable code snippets and the complete code of the demo, please refer Java database connectivity (JDBC) is the JavaSoft specification of a standard application programming interface (API) that allows Java programs to access database management systems. Many databases, such as MySQL or PostgreSQL, have implemented their own drivers based on the JDBC API. -Since GreptimeDB supports [mutiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC. +Since GreptimeDB supports [multiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC. If you want to use other protocols, just replace the MySQL driver with the corresponding driver. %} diff --git a/docs/v0.7/en/user-guide/clients/influxdb-line.md b/docs/v0.7/en/user-guide/clients/influxdb-line.md index a3658db3d..4cb94d5e4 100644 --- a/docs/v0.7/en/user-guide/clients/influxdb-line.md +++ b/docs/v0.7/en/user-guide/clients/influxdb-line.md @@ -6,7 +6,7 @@ GreptimeDB is compatible with InfluxDB's line protocol authentication format, bo **[V2 protocol](https://docs.influxdata.com/influxdb/v1.8/tools/api/?t=Auth+Enabled#apiv2query-http-endpoint)** -InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protcol. +InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protocol. ```shell ❯ curl 'http://localhost:4000/v1/influxdb/api/v2/write?db=public' \ diff --git a/docs/v0.7/en/user-guide/cluster.md b/docs/v0.7/en/user-guide/cluster.md index 698554197..d309f6cee 100644 --- a/docs/v0.7/en/user-guide/cluster.md +++ b/docs/v0.7/en/user-guide/cluster.md @@ -2,7 +2,7 @@ ## Create a cluster -Please refer to [Kubernetes](./operations/kubernetes.md) to get the infomation about creating a Kubernetes cluster. +Please refer to [Kubernetes](./operations/kubernetes.md) to get the information about creating a Kubernetes cluster. ## Distributed Read/Write diff --git a/docs/v0.7/en/user-guide/concepts/overview.md b/docs/v0.7/en/user-guide/concepts/overview.md index c17bda840..bee3c88bf 100644 --- a/docs/v0.7/en/user-guide/concepts/overview.md +++ b/docs/v0.7/en/user-guide/concepts/overview.md @@ -1,6 +1,6 @@ # Overview -- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performence, and user-friendly. +- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performance, and user-friendly. - [Data Model](./data-model.md): This document describes the data model of GreptimeDB, including table schema, index columns, etc. - [Architecture](./architecture.md): Get the cloud-native architecture of GreptimeDB. - [Storage Location](./storage-location.md): This document describes the storage location of GreptimeDB, including local disk, HDFS, and cloud object storage such as S3, Azure Blob Storage, etc. diff --git a/docs/v0.7/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md b/docs/v0.7/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md index f7bb6c62c..e7741f173 100644 --- a/docs/v0.7/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md +++ b/docs/v0.7/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md @@ -306,7 +306,7 @@ For more information on PromQL, please refer to the [PromQL](https://prometheus. ## Visualize data -It is recommanded using Grafana to visualize data in GreptimeDB. +It is recommended using Grafana to visualize data in GreptimeDB. Please refer to the [Grafana documentation](/user-guide/clients/grafana) for details on configuring GreptimeDB. ## Migrate data diff --git a/docs/v0.7/en/user-guide/operations/configuration.md b/docs/v0.7/en/user-guide/operations/configuration.md index 46a685092..a612f9f3e 100644 --- a/docs/v0.7/en/user-guide/operations/configuration.md +++ b/docs/v0.7/en/user-guide/operations/configuration.md @@ -61,7 +61,7 @@ greptime metasrv start --help - `--http-timeout `: HTTP request timeout in seconds. - `--selector `: You can refer [selector-type](/contributor-guide/metasrv/selector#selector-type); - `--server-addr `: The communication server address for frontend and datanode to connect to metasrv; -- `--store-addr `: Comma seperated etcd server addresses to store metadata; +- `--store-addr `: Comma separated etcd server addresses to store metadata; - `--use-memory-store`: Use memory store instead of etcd, for test purpose only; ### Frontend subcommand options diff --git a/docs/v0.7/en/user-guide/python-scripts/getting-started.md b/docs/v0.7/en/user-guide/python-scripts/getting-started.md index 5c1ea263b..c41654a5d 100644 --- a/docs/v0.7/en/user-guide/python-scripts/getting-started.md +++ b/docs/v0.7/en/user-guide/python-scripts/getting-started.md @@ -14,7 +14,7 @@ conda create --name Greptime python= + ## SQL diff --git a/docs/v0.7/en/user-guide/table-management.md b/docs/v0.7/en/user-guide/table-management.md index 52f78672d..2f1e4e5b7 100644 --- a/docs/v0.7/en/user-guide/table-management.md +++ b/docs/v0.7/en/user-guide/table-management.md @@ -9,7 +9,7 @@ For more explanations of the `SQL` syntax, please see the [SQL reference](/refer ## Create Database -The default database is `public`. You can create a database manully. +The default database is `public`. You can create a database manually. ```sql CREATE DATABASE test; diff --git a/docs/v0.7/zh/user-guide/clients/otlp.md b/docs/v0.7/zh/user-guide/clients/otlp.md index b32963495..d0aed2b0a 100644 --- a/docs/v0.7/zh/user-guide/clients/otlp.md +++ b/docs/v0.7/zh/user-guide/clients/otlp.md @@ -79,5 +79,5 @@ OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型 - 所有的 Attribute ，包含 resource 级别、scope 级别和 data_point 级别，都被作为 GreptimeDB 表的 tag 列。 - 数据点的时间戳被作为 GreptimeDB 的时间戳索引，列名 greptime_timestamp。 - Gauge/Sum 两种类型的数据点数据被作为 field 列，列名 greptime_value。 -- Summay 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 +- Summary 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如 90 / 99 等。 - Histogram 和 ExponentialHistogram 暂时未被支持，我们可能在后续版本中推出 Histogram 数据类型来原生支持这两种类型。 diff --git a/docs/v0.7/zh/user-guide/query-data/promql.md b/docs/v0.7/zh/user-guide/query-data/promql.md index c906f488e..26d9244f2 100644 --- a/docs/v0.7/zh/user-guide/query-data/promql.md +++ b/docs/v0.7/zh/user-guide/query-data/promql.md @@ -112,7 +112,7 @@ curl -X GET \ "execution_time_ms": 5 } ``` - + ## SQL diff --git a/typos.toml b/typos.toml new file mode 100644 index 000000000..a998db7b4 --- /dev/null +++ b/typos.toml @@ -0,0 +1,8 @@ +[default.extend-words] +# random strings +yello = "yello" +datas = "datas" + +# tech abbreviations +ND = "ND" +RTO = "RTO"