Skip to content

[Minor] improvement(docs): Polish docs #4527

Merged
jerryshao merged 5 commits intoapache:mainfrom
yuqi1129:docs_fix
Aug 15, 2024
Merged

[Minor] improvement(docs): Polish docs #4527
jerryshao merged 5 commits intoapache:mainfrom
yuqi1129:docs_fix

Conversation

@yuqi1129
Copy link
Contributor

What changes were proposed in this pull request?

Refine docs as we are going to release version 0.6.0-incubating.

Why are the changes needed?

Better user experience.

Does this PR introduce any user-facing change?

N/A

How was this patch tested?

N/A

@yuqi1129 yuqi1129 self-assigned this Aug 15, 2024
- [**PostgreSQL**](./jdbc-postgresql-catalog.md)
- [**Doris**](./jdbc-doris-catalog.md)
- [**Apache Iceberg**](./lakehouse-iceberg-catalog.md)
- [**Apache Paimon**](./lakehouse-paimon-catalog.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There're many places need to add Paimon, not just only here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, let me check it thoroughly.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also let @FANNG1 or @caican00 to modify the doc if you're not sure about Paimon part.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@caican00 is planing to propose a PR to fix the document today.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean @caican00 will modify the Paimon-related content in the file manage-relational-metadata-using-gravitino.md? If so, should I make any changes to this PR?

Copy link
Contributor

@jerryshao jerryshao Aug 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If @caican00 will work on this, @yuqi1129 you can leave this file as it is.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I will revert changes to this file, if @caican00 has no time to do it, I would raise a another PR to fix it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@yuqi1129 yuqi1129 requested a review from FANNG1 August 15, 2024 04:04
@yuqi1129
Copy link
Contributor Author

@FANNG1
Could you also help me review this PR?

### What kind of backend storage are supported

Currently, relational backend storage supports the `JDBCBackend`, and uses `MySQL` as the
Currently, relational backend storage supports the `JDBCBackend` and `MySQL` and `H2` are supported, `H2` is the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...backend storage supports the JDBCBackend, MySQL and H2 are supported..."

Before the version `0.5.0`, Apache Gravitino only supports KV backend storage to store metadata. Since
RDBMS is widely used in the industry, starting from the version `0.5.0`, Gravitino supports using
Before the version `0.6.0`, Apache Gravitino supports KV and Relational backend storage to store metadata. Since KV storage is
hard to manage and RDBMS is widely used in the industry, starting from the version `0.6.0`, Gravitino will not support KV backend, and it only supports using
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to explain the reason.

"Since KV storage is
hard to manage and RDBMS is widely used in the industry, starting from the version 0.6.0, Gravitino will not support KV backend, and it only supports using"

=>

"Since 0.6.0, Gravitino only supports using"

@jerryshao
Copy link
Contributor

@yuqi1129 can you please help me to change line

http://localhost:8090/api/metalakes/test/tags?detailed=true

changes to:

http://localhost:8090/api/metalakes/test/tags?details=true

@yuqi1129
Copy link
Contributor Author

manage-tags-in-gravitino.md

@yuqi1129 can you please help me to change line

http://localhost:8090/api/metalakes/test/tags?detailed=true

changes to:

http://localhost:8090/api/metalakes/test/tags?details=true

Done.

@jerryshao jerryshao merged commit e8d93bf into apache:main Aug 15, 2024
github-actions bot pushed a commit that referenced this pull request Aug 15, 2024
### What changes were proposed in this pull request?

Refine docs as we are going to release version 0.6.0-incubating.

### Why are the changes needed?

Better user experience.

### Does this PR introduce _any_ user-facing change?

N/A

### How was this patch tested?

N/A
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants