This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch branch-0.8
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/branch-0.8 by this push:
new 6c98102900 [MINOR] docs: fix several typo in docs (#6886)
6c98102900 is described below
commit 6c98102900ec1274808934c0b060dc36a0826738
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Apr 15 13:09:14 2025 +0800
[MINOR] docs: fix several typo in docs (#6886)
### What changes were proposed in this pull request?
- fix several typo in docs
- add .vscode to gitignore
### Why are the changes needed?
typo
### Does this PR introduce _any_ user-facing change?
N/A
### How was this patch tested?
N/A
---------
Co-authored-by: Kang <[email protected]>
Co-authored-by: Zhou Kang <[email protected]>
---
.gitignore | 2 ++
docs/how-to-upgrade.md | 2 +-
docs/how-to-use-gvfs.md | 8 ++++----
docs/jdbc-mysql-catalog.md | 4 ++--
docs/lakehouse-paimon-catalog.md | 2 +-
docs/metrics.md | 2 +-
6 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/.gitignore b/.gitignore
index eae3d3c952..1495d0cac3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -27,6 +27,8 @@ replay_pid*
**/.gradle
**/.idea
!/.idea/icon.svg
+!.idea/vcs.xml
+**/.vscode
**/build
gen
**/.DS_Store
diff --git a/docs/how-to-upgrade.md b/docs/how-to-upgrade.md
index ef502dabfe..d9f7aac1ef 100644
--- a/docs/how-to-upgrade.md
+++ b/docs/how-to-upgrade.md
@@ -5,7 +5,7 @@ license: "This software is licensed under the Apache License
version 2."
---
## Introduction
-This document describes how to upgrade the schema of backed
+This document describes how to upgrade the schema of backend
Gravitino instance from one release version of Gravitino to another
release version of Gravitino. For example, by following the steps listed
below it is possible to upgrade a Gravitino 0.6.0 schema to a
diff --git a/docs/how-to-use-gvfs.md b/docs/how-to-use-gvfs.md
index cbbb67dd37..bbe975851e 100644
--- a/docs/how-to-use-gvfs.md
+++ b/docs/how-to-use-gvfs.md
@@ -419,7 +419,7 @@
fs.ls(path="gvfs://fileset/fileset_catalog/tmp/tmp_fileset/sub_dir")
# get file info under the fileset
fs.info(path="gvfs://fileset/fileset_catalog/tmp/tmp_fileset/sub_dir/test.parquet")
-# check a file or a diretory whether exists
+# check a file or a directory whether exists
fs.exists(path="gvfs://fileset/fileset_catalog/tmp/tmp_fileset/sub_dir")
# write something into a file
@@ -563,7 +563,7 @@ from gravitino import gvfs
options = {"auth_type": "simple"}
fs = gvfs.GravitinoVirtualFileSystem(server_uri="http://localhost:8090";,
metalake_name="test_metalake", options=options)
-print(fs.ls("gvfs://fileset/fileset_catlaog/tmp/test_fileset"))
+print(fs.ls("gvfs://fileset/fileset_catalog/tmp/test_fileset"))
```
##### Using `OAuth` authentication
@@ -584,5 +584,5 @@ options = {
GVFSConfig.OAUTH2_PATH: "token/test",
}
fs = gvfs.GravitinoVirtualFileSystem(server_uri="http://localhost:8090";,
metalake_name="test_metalake", options=options)
-print(fs.ls("gvfs://fileset/fileset_catlaog/tmp/test_fileset"))
-```
\ No newline at end of file
+print(fs.ls("gvfs://fileset/fileset_catalog/tmp/test_fileset"))
+```
diff --git a/docs/jdbc-mysql-catalog.md b/docs/jdbc-mysql-catalog.md
index 808e229a21..ae27175596 100644
--- a/docs/jdbc-mysql-catalog.md
+++ b/docs/jdbc-mysql-catalog.md
@@ -28,7 +28,7 @@ Gravitino saves some system information in schema and table
comment, like `(From
- Supports DDL operation for MySQL databases and tables.
- Supports table index.
- Supports [column default
value](./manage-relational-metadata-using-gravitino.md#table-column-default-value)
and
[auto-increment](./manage-relational-metadata-using-gravitino.md#table-column-auto-increment).
-- Supports managing MySQL table features though table properties, like using
`engine` to set MySQL storage engine.
+- Supports managing MySQL table features through table properties, like using
`engine` to set MySQL storage engine.
### Catalog properties
@@ -83,7 +83,7 @@ Refer to [Manage Relational Metadata Using
Gravitino](./manage-relational-metada
- Supports DDL operation for MySQL tables.
- Supports index.
- Supports [column default
value](./manage-relational-metadata-using-gravitino.md#table-column-default-value)
and
[auto-increment](./manage-relational-metadata-using-gravitino.md#table-column-auto-increment)..
-- Supports managing MySQL table features though table properties, like using
`engine` to set MySQL storage engine.
+- Supports managing MySQL table features through table properties, like using
`engine` to set MySQL storage engine.
### Table column types
diff --git a/docs/lakehouse-paimon-catalog.md b/docs/lakehouse-paimon-catalog.md
index b67fe37db3..aa4c1759df 100644
--- a/docs/lakehouse-paimon-catalog.md
+++ b/docs/lakehouse-paimon-catalog.md
@@ -43,7 +43,7 @@ Builds with Apache Paimon `0.8.0`.
| `authentication.kerberos.keytab-fetch-timeout-sec` | The fetch timeout of
retrieving Kerberos keytab from `authentication.kerberos.keytab-uri`.
| 60
| No
[...]
| `oss-endpoint` | The endpoint of the
Aliyun OSS.
| (none)
| required if the value of `warehouse` is a OSS path
[...]
| `oss-access-key-id` | The access key of the
Aliyun OSS.
| (none)
| required if the value of `warehouse` is a OSS path
[...]
-| `oss-accesss-key-secret` | The secret key the
Aliyun OSS.
| (none)
| required if the value of `warehouse` is a OSS path
[...]
+| `oss-access-key-secret` | The secret key the
Aliyun OSS.
| (none)
| required if the value of `warehouse` is a OSS path
[...]
| `s3-endpoint` | The endpoint of the AWS
S3.
| (none)
| required if the value of `warehouse` is a S3 path
[...]
| `s3-access-key-id` | The access key of the
AWS S3.
| (none)
| required if the value of `warehouse` is a S3 path
[...]
| `s3-secret-access-key` | The secret key of the
AWS S3.
| (none)
| required if the value of `warehouse` is a S3 path
[...]
diff --git a/docs/metrics.md b/docs/metrics.md
index 0127f859a4..85738fe7e7 100644
--- a/docs/metrics.md
+++ b/docs/metrics.md
@@ -48,4 +48,4 @@ Metrics with the `gravitino-server` prefix pertain to the
Gravitino server, whil
#### JVM metrics
JVM metrics source uses [JVM
instrumentation](https://metrics.dropwizard.io/4.2.0/manual/jvm.html) with
BufferPoolMetricSet, GarbageCollectorMetricSet, and MemoryUsageGaugeSet.
-These metrics start with the `jvm` prefix, like `jvm.heap.used` in JSON
format, `jvm_head_used` in Prometheus format.
+These metrics start with the `jvm` prefix, like `jvm.heap.used` in JSON
format, `jvm_heap_used` in Prometheus format.
