apache / gravitino

World's most powerful open data catalog for building a high-performance, geo-distributed and federated metadata lake.
https://gravitino.apache.org
Apache License 2.0
1.1k stars 345 forks source link

[Improvement] use incubating version in docs #5114

Closed mchades closed 1 month ago

mchades commented 1 month ago

What would you like to be improved?

Gravitino has become an Apache Incubator project since version 0.6.0, so it is necessary to follow the Apache versioning convention like 0.6.0-incubating instead of 0.6.0.

How should we improve?

visit all docs and update to incubating version after 0.6.0. Such as: https://github.com/apache/gravitino/blob/344e98df063548232f08a45a22fa06ebc26f6583/docs/how-to-use-gvfs.md?plain=1#L338-L348

should change the Since version column value to:

 | Configuration item   | Description                                                                                                                                              | Default value | Required                          | Since version | 
 |----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-----------------------------------|---------------| 
 | `server_uri`         | The Gravitino server uri, e.g. `http://localhost:8090`.                                                                                                  | (none)        | Yes                               | 0.6.0-incubating         |.     
 | `metalake_name`      | The metalake name which the fileset belongs to.                                                                                                          | (none)        | Yes                               | 0.6.0-incubating          |. 
 | `cache_size`         | The cache capacity of the Gravitino Virtual File System.                                                                                                 | `20`          | No                                | 0.6.0-incubating          |.        
 | `cache_expired_time` | The value of time that the cache expires after accessing in the Gravitino Virtual File System. The value is in `seconds`.                                | `3600`        | No                                | 0.6.0-incubating          |. 
 | `auth_type`          | The auth type to initialize the Gravitino client to use with the Gravitino Virtual File System. Currently supports `simple` and `oauth2` auth types.     | `simple`      | No                                | 0.6.0-incubating          |. 
 | `oauth2_server_uri`  | The auth server URI for the Gravitino client when using `oauth2` auth type.                                                                              | (none)        | Yes if you use `oauth2` auth type | 0.7.0-incubating          |. 
 | `oauth2_credential`  | The auth credential for the Gravitino client when using `oauth2` auth type.                                                                              | (none)        | Yes if you use `oauth2` auth type | 0.7.0-incubating          |. 
 | `oauth2_path`        | The auth server path for the Gravitino client when using `oauth2` auth type. Please remove the first slash `/` from the path, for example `oauth/token`. | (none)        | Yes if you use `oauth2` auth type | 0.7.0-incubating          |. 
 | `oauth2_scope`       | The auth scope for the Gravitino client when using `oauth2` auth type with the Gravitino Virtual File System.                                            | (none)        | Yes if you use `oauth2` auth type | 0.7.0-incubating          |. 
lsyulong commented 1 month ago

Hello, I would like to give this a try. Can you assign the task to me so that I can fix all the issues in the documentation under doc

mchades commented 1 month ago

Hello, I would like to give this a try. Can you assign the task to me so that I can fix all the issues in the documentation under doc

Sure, welcome~

lsyulong commented 1 month ago

Hello, I would like to give this a try. Can you assign the task to me so that I can fix all the issues in the documentation under doc

Sure, welcome~

image Hello, during the editing process, I found that the data type of Gravitino in the document is incorrect. It should be a list

mchades commented 1 month ago

@lsyulong you can correct them in one PR

lsyulong commented 1 month ago

@lsyulong you can correct them in one PR

I commit the PR