You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "Xuanwo (via GitHub)" <gi...@apache.org> on 2024/07/06 04:33:22 UTC
[PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Xuanwo opened a new pull request, #444:
URL: https://github.com/apache/iceberg-rust/pull/444
Part of https://github.com/apache/iceberg-rust/issues/429
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "liurenjie1024 (via GitHub)" <gi...@apache.org>.
liurenjie1024 commented on PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444#issuecomment-2213293057
Thanks @Xuanwo for this pr! And @sdd @Fokko for review.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444#issuecomment-2213258492
All comments have been resovled. PTAL @liurenjie1024 @Fokko @sdd
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "sdd (via GitHub)" <gi...@apache.org>.
sdd commented on code in PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444#discussion_r1668065947
##########
README.md:
##########
@@ -17,89 +17,62 @@
~ under the License.
-->
-# Apache Iceberg Rust
-
-Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/).
-
-## Roadmap
-
-### Catalog
-
-| Catalog Type | Status |
-| ------------ | ----------- |
-| Rest | Done |
-| Hive | Done |
-| Sql | In Progress |
-| Glue | Done |
-| DynamoDB | Not Started |
-
-### FileIO
-
-| FileIO Type | Status |
-| ----------- | ----------- |
-| S3 | Done |
-| Local File | Done |
-| GCS | Not Started |
-| HDFS | Not Started |
-
-Our `FileIO` is powered by [Apache OpenDAL](https://github.com/apache/opendal), so it would be quite easy to
-expand to other service.
-
-### Table API
-
-#### Reader
-
-| Feature | Status |
-| ---------------------------------------------------------- | ----------- |
-| File based task planning | Done |
-| Size based task planning | Not started |
-| Filter pushdown(manifest evaluation, partition prunning) | In Progress |
-| Apply deletions, including equality and position deletions | Not started |
-| Read into arrow record batch | In Progress |
-| Parquet file support | Done |
-| ORC file support | Not started |
-
-#### Writer
-
-| Feature | Status |
-| ------------------------ | ----------- |
-| Data writer | Not started |
-| Equality deletion writer | Not started |
-| Position deletion writer | Not started |
-| Partitioned writer | Not started |
-| Upsert writer | Not started |
-| Parquet file support | Not started |
-| ORC file support | Not started |
-
-#### Transaction
-
-| Feature | Status |
-| --------------------- | ----------- |
-| Schema evolution | Not started |
-| Update partition spec | Not started |
-| Update properties | Not started |
-| Replace sort order | Not started |
-| Update location | Not started |
-| Append files | Not started |
-| Rewrite files | Not started |
-| Rewrite manifests | Not started |
-| Overwrite files | Not started |
-| Row level updates | Not started |
-| Replace partitions | Not started |
-| Snapshot management | Not started |
-
-### Integrations
-
-We will add integrations with other rust based data systems, such as polars, datafusion, etc.
+# Apache Iceberg™ Rust
+
+
+
+Rust implementation of [Apache Iceberg™](https://iceberg.apache.org/).
+
+Working on [v0.3.0 Release Milestone](https://github.com/apache/iceberg-rust/milestone/2)
+
+## Components
+
+The Apache Iceberg Rust project is composed of the following components:
+
+| Name | Release | Docs |
+|------------------------|------------------------------------------------------------|------------------------------------------------------|
+| [iceberg] | [![iceberg image]][iceberg link] | [![docs release]][iceberg release docs] |
+| [iceberg-datafusion] | - | - |
+| [iceberg-catalog-glue] | - | - |
+| [iceberg-catalog-hms] | [![iceberg-catalog-hms image]][iceberg-catalog-hms link] | [![docs release]][iceberg-catalog-hms release docs] |
+| [iceberg-catalog-rest] | [![iceberg-catalog-rest image]][iceberg-catalog-rest link] | [![docs release]][iceberg-catalog-rest release docs] |
+
+[docs release]: https://img.shields.io/badge/docs-release-blue
+[iceberg]: crates/iceberg/README.md
+[iceberg image]: https://img.shields.io/crates/v/iceberg.svg
+[iceberg link]: https://crates.io/crates/iceberg
+[iceberg release docs]: https://docs.rs/iceberg
+
+[iceberg-datafusion]: crates/integrations/datafusion/README.md
+
+[iceberg-catalog-glue]: crates/catalog/glue/README.md
+
+[iceberg-catalog-hms]: crates/catalog/hms/README.md
+[iceberg-catalog-hms image]: https://img.shields.io/crates/v/iceberg-catalog-hms.svg
+[iceberg-catalog-hms link]: https://crates.io/crates/iceberg-catalog-hms
+[iceberg-catalog-hms release docs]: https://docs.rs/iceberg-catalog-hms
+
+[iceberg-catalog-rest]: crates/catalog/rest/README.md
+[iceberg-catalog-rest image]: https://img.shields.io/crates/v/iceberg-catalog-rest.svg
+[iceberg-catalog-rest link]: https://crates.io/crates/iceberg-catalog-rest
+[iceberg-catalog-rest release docs]: https://docs.rs/iceberg-catalog-rest
## Contribute
-Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are some ways to go.
+Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are
+some ways to go.
- Start with [Contributing Guide](CONTRIBUTING.md).
- Submit [Issues](https://github.com/apache/iceberg-rust/issues/new) for bug report or feature requests.
-- Discuss at [dev mailing list](mailto:dev@iceberg.apache.org) ([subscribe](<mailto:dev-subscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20subscribe)>) / [unsubscribe](<mailto:dev-unsubscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20unsubscribe)>) / [archives](https://lists.apache.org/list.html?dev@iceberg.apache.org))
-- Talk to community directly at [Slack #rust channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A).
+- Discuss
+ at [dev mailing list](mailto:dev@iceberg.apache.org) ([subscribe](<mailto:dev-subscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20subscribe)>) / [unsubscribe](<mailto:dev-unsubscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20unsubscribe)>) / [archives](https://lists.apache.org/list.html?dev@iceberg.apache.org))
+- Talk to community directly
Review Comment:
Talk to **the** community directly
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444#discussion_r1668139594
##########
README.md:
##########
@@ -17,89 +17,62 @@
~ under the License.
-->
-# Apache Iceberg Rust
-
-Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/).
-
-## Roadmap
-
-### Catalog
-
-| Catalog Type | Status |
-| ------------ | ----------- |
-| Rest | Done |
-| Hive | Done |
-| Sql | In Progress |
-| Glue | Done |
-| DynamoDB | Not Started |
-
-### FileIO
-
-| FileIO Type | Status |
-| ----------- | ----------- |
-| S3 | Done |
-| Local File | Done |
-| GCS | Not Started |
-| HDFS | Not Started |
-
-Our `FileIO` is powered by [Apache OpenDAL](https://github.com/apache/opendal), so it would be quite easy to
-expand to other service.
-
-### Table API
-
-#### Reader
-
-| Feature | Status |
-| ---------------------------------------------------------- | ----------- |
-| File based task planning | Done |
-| Size based task planning | Not started |
-| Filter pushdown(manifest evaluation, partition prunning) | In Progress |
-| Apply deletions, including equality and position deletions | Not started |
-| Read into arrow record batch | In Progress |
-| Parquet file support | Done |
-| ORC file support | Not started |
-
-#### Writer
-
-| Feature | Status |
-| ------------------------ | ----------- |
-| Data writer | Not started |
-| Equality deletion writer | Not started |
-| Position deletion writer | Not started |
-| Partitioned writer | Not started |
-| Upsert writer | Not started |
-| Parquet file support | Not started |
-| ORC file support | Not started |
-
-#### Transaction
-
-| Feature | Status |
-| --------------------- | ----------- |
-| Schema evolution | Not started |
-| Update partition spec | Not started |
-| Update properties | Not started |
-| Replace sort order | Not started |
-| Update location | Not started |
-| Append files | Not started |
-| Rewrite files | Not started |
-| Rewrite manifests | Not started |
-| Overwrite files | Not started |
-| Row level updates | Not started |
-| Replace partitions | Not started |
-| Snapshot management | Not started |
-
-### Integrations
-
-We will add integrations with other rust based data systems, such as polars, datafusion, etc.
+# Apache Iceberg™ Rust
+
+
+
+Rust implementation of [Apache Iceberg™](https://iceberg.apache.org/).
+
+Working on [v0.3.0 Release Milestone](https://github.com/apache/iceberg-rust/milestone/2)
+
+## Components
+
+The Apache Iceberg Rust project is composed of the following components:
+
+| Name | Release | Docs |
+|------------------------|------------------------------------------------------------|------------------------------------------------------|
+| [iceberg] | [![iceberg image]][iceberg link] | [![docs release]][iceberg release docs] |
+| [iceberg-datafusion] | - | - |
+| [iceberg-catalog-glue] | - | - |
+| [iceberg-catalog-hms] | [![iceberg-catalog-hms image]][iceberg-catalog-hms link] | [![docs release]][iceberg-catalog-hms release docs] |
+| [iceberg-catalog-rest] | [![iceberg-catalog-rest image]][iceberg-catalog-rest link] | [![docs release]][iceberg-catalog-rest release docs] |
+
+[docs release]: https://img.shields.io/badge/docs-release-blue
+[iceberg]: crates/iceberg/README.md
+[iceberg image]: https://img.shields.io/crates/v/iceberg.svg
+[iceberg link]: https://crates.io/crates/iceberg
+[iceberg release docs]: https://docs.rs/iceberg
+
+[iceberg-datafusion]: crates/integrations/datafusion/README.md
+
+[iceberg-catalog-glue]: crates/catalog/glue/README.md
+
+[iceberg-catalog-hms]: crates/catalog/hms/README.md
+[iceberg-catalog-hms image]: https://img.shields.io/crates/v/iceberg-catalog-hms.svg
+[iceberg-catalog-hms link]: https://crates.io/crates/iceberg-catalog-hms
+[iceberg-catalog-hms release docs]: https://docs.rs/iceberg-catalog-hms
+
+[iceberg-catalog-rest]: crates/catalog/rest/README.md
+[iceberg-catalog-rest image]: https://img.shields.io/crates/v/iceberg-catalog-rest.svg
+[iceberg-catalog-rest link]: https://crates.io/crates/iceberg-catalog-rest
+[iceberg-catalog-rest release docs]: https://docs.rs/iceberg-catalog-rest
## Contribute
-Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are some ways to go.
+Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are
+some ways to go.
- Start with [Contributing Guide](CONTRIBUTING.md).
- Submit [Issues](https://github.com/apache/iceberg-rust/issues/new) for bug report or feature requests.
-- Discuss at [dev mailing list](mailto:dev@iceberg.apache.org) ([subscribe](<mailto:dev-subscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20subscribe)>) / [unsubscribe](<mailto:dev-unsubscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20unsubscribe)>) / [archives](https://lists.apache.org/list.html?dev@iceberg.apache.org))
-- Talk to community directly at [Slack #rust channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A).
+- Discuss
+ at [dev mailing list](mailto:dev@iceberg.apache.org) ([subscribe](<mailto:dev-subscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20subscribe)>) / [unsubscribe](<mailto:dev-unsubscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20unsubscribe)>) / [archives](https://lists.apache.org/list.html?dev@iceberg.apache.org))
+- Talk to community directly
Review Comment:
Fixed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "liurenjie1024 (via GitHub)" <gi...@apache.org>.
liurenjie1024 merged PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444#issuecomment-2213162101
> Looks good. I'm not normally as picky about getting the english exactly correct as long as it is understandable, but for the main Readme.md I think we want it perfect :-)
Thanks for the review. I will address those comments later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "sdd (via GitHub)" <gi...@apache.org>.
sdd commented on code in PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444#discussion_r1668065324
##########
README.md:
##########
@@ -17,89 +17,62 @@
~ under the License.
-->
-# Apache Iceberg Rust
-
-Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/).
-
-## Roadmap
-
-### Catalog
-
-| Catalog Type | Status |
-| ------------ | ----------- |
-| Rest | Done |
-| Hive | Done |
-| Sql | In Progress |
-| Glue | Done |
-| DynamoDB | Not Started |
-
-### FileIO
-
-| FileIO Type | Status |
-| ----------- | ----------- |
-| S3 | Done |
-| Local File | Done |
-| GCS | Not Started |
-| HDFS | Not Started |
-
-Our `FileIO` is powered by [Apache OpenDAL](https://github.com/apache/opendal), so it would be quite easy to
-expand to other service.
-
-### Table API
-
-#### Reader
-
-| Feature | Status |
-| ---------------------------------------------------------- | ----------- |
-| File based task planning | Done |
-| Size based task planning | Not started |
-| Filter pushdown(manifest evaluation, partition prunning) | In Progress |
-| Apply deletions, including equality and position deletions | Not started |
-| Read into arrow record batch | In Progress |
-| Parquet file support | Done |
-| ORC file support | Not started |
-
-#### Writer
-
-| Feature | Status |
-| ------------------------ | ----------- |
-| Data writer | Not started |
-| Equality deletion writer | Not started |
-| Position deletion writer | Not started |
-| Partitioned writer | Not started |
-| Upsert writer | Not started |
-| Parquet file support | Not started |
-| ORC file support | Not started |
-
-#### Transaction
-
-| Feature | Status |
-| --------------------- | ----------- |
-| Schema evolution | Not started |
-| Update partition spec | Not started |
-| Update properties | Not started |
-| Replace sort order | Not started |
-| Update location | Not started |
-| Append files | Not started |
-| Rewrite files | Not started |
-| Rewrite manifests | Not started |
-| Overwrite files | Not started |
-| Row level updates | Not started |
-| Replace partitions | Not started |
-| Snapshot management | Not started |
-
-### Integrations
-
-We will add integrations with other rust based data systems, such as polars, datafusion, etc.
+# Apache Iceberg™ Rust
+
+
+
+Rust implementation of [Apache Iceberg™](https://iceberg.apache.org/).
+
+Working on [v0.3.0 Release Milestone](https://github.com/apache/iceberg-rust/milestone/2)
+
+## Components
+
+The Apache Iceberg Rust project is composed of the following components:
+
+| Name | Release | Docs |
+|------------------------|------------------------------------------------------------|------------------------------------------------------|
+| [iceberg] | [![iceberg image]][iceberg link] | [![docs release]][iceberg release docs] |
+| [iceberg-datafusion] | - | - |
+| [iceberg-catalog-glue] | - | - |
+| [iceberg-catalog-hms] | [![iceberg-catalog-hms image]][iceberg-catalog-hms link] | [![docs release]][iceberg-catalog-hms release docs] |
+| [iceberg-catalog-rest] | [![iceberg-catalog-rest image]][iceberg-catalog-rest link] | [![docs release]][iceberg-catalog-rest release docs] |
+
+[docs release]: https://img.shields.io/badge/docs-release-blue
+[iceberg]: crates/iceberg/README.md
+[iceberg image]: https://img.shields.io/crates/v/iceberg.svg
+[iceberg link]: https://crates.io/crates/iceberg
+[iceberg release docs]: https://docs.rs/iceberg
+
+[iceberg-datafusion]: crates/integrations/datafusion/README.md
+
+[iceberg-catalog-glue]: crates/catalog/glue/README.md
+
+[iceberg-catalog-hms]: crates/catalog/hms/README.md
+[iceberg-catalog-hms image]: https://img.shields.io/crates/v/iceberg-catalog-hms.svg
+[iceberg-catalog-hms link]: https://crates.io/crates/iceberg-catalog-hms
+[iceberg-catalog-hms release docs]: https://docs.rs/iceberg-catalog-hms
+
+[iceberg-catalog-rest]: crates/catalog/rest/README.md
+[iceberg-catalog-rest image]: https://img.shields.io/crates/v/iceberg-catalog-rest.svg
+[iceberg-catalog-rest link]: https://crates.io/crates/iceberg-catalog-rest
+[iceberg-catalog-rest release docs]: https://docs.rs/iceberg-catalog-rest
## Contribute
-Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are some ways to go.
+Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are
+some ways to go.
Review Comment:
I'd suggest "Here are some ways to get involved".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on code in PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444#discussion_r1668090507
##########
README.md:
##########
@@ -17,89 +17,62 @@
~ under the License.
-->
-# Apache Iceberg Rust
-
-Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/).
-
-## Roadmap
-
-### Catalog
-
-| Catalog Type | Status |
-| ------------ | ----------- |
-| Rest | Done |
-| Hive | Done |
-| Sql | In Progress |
-| Glue | Done |
-| DynamoDB | Not Started |
-
-### FileIO
-
-| FileIO Type | Status |
-| ----------- | ----------- |
-| S3 | Done |
-| Local File | Done |
-| GCS | Not Started |
-| HDFS | Not Started |
-
-Our `FileIO` is powered by [Apache OpenDAL](https://github.com/apache/opendal), so it would be quite easy to
-expand to other service.
-
-### Table API
-
-#### Reader
-
-| Feature | Status |
-| ---------------------------------------------------------- | ----------- |
-| File based task planning | Done |
-| Size based task planning | Not started |
-| Filter pushdown(manifest evaluation, partition prunning) | In Progress |
-| Apply deletions, including equality and position deletions | Not started |
-| Read into arrow record batch | In Progress |
-| Parquet file support | Done |
-| ORC file support | Not started |
-
-#### Writer
-
-| Feature | Status |
-| ------------------------ | ----------- |
-| Data writer | Not started |
-| Equality deletion writer | Not started |
-| Position deletion writer | Not started |
-| Partitioned writer | Not started |
-| Upsert writer | Not started |
-| Parquet file support | Not started |
-| ORC file support | Not started |
-
-#### Transaction
-
-| Feature | Status |
-| --------------------- | ----------- |
-| Schema evolution | Not started |
-| Update partition spec | Not started |
-| Update properties | Not started |
-| Replace sort order | Not started |
-| Update location | Not started |
-| Append files | Not started |
-| Rewrite files | Not started |
-| Rewrite manifests | Not started |
-| Overwrite files | Not started |
-| Row level updates | Not started |
-| Replace partitions | Not started |
-| Snapshot management | Not started |
-
-### Integrations
-
-We will add integrations with other rust based data systems, such as polars, datafusion, etc.
+# Apache Iceberg™ Rust
+
+
+
+Rust implementation of [Apache Iceberg™](https://iceberg.apache.org/).
+
+Working on [v0.3.0 Release Milestone](https://github.com/apache/iceberg-rust/milestone/2)
+
+## Components
+
+The Apache Iceberg Rust project is composed of the following components:
+
+| Name | Release | Docs |
+|------------------------|------------------------------------------------------------|------------------------------------------------------|
+| [iceberg] | [![iceberg image]][iceberg link] | [![docs release]][iceberg release docs] |
+| [iceberg-datafusion] | - | - |
+| [iceberg-catalog-glue] | - | - |
+| [iceberg-catalog-hms] | [![iceberg-catalog-hms image]][iceberg-catalog-hms link] | [![docs release]][iceberg-catalog-hms release docs] |
+| [iceberg-catalog-rest] | [![iceberg-catalog-rest image]][iceberg-catalog-rest link] | [![docs release]][iceberg-catalog-rest release docs] |
+
+[docs release]: https://img.shields.io/badge/docs-release-blue
+[iceberg]: crates/iceberg/README.md
+[iceberg image]: https://img.shields.io/crates/v/iceberg.svg
+[iceberg link]: https://crates.io/crates/iceberg
+[iceberg release docs]: https://docs.rs/iceberg
+
+[iceberg-datafusion]: crates/integrations/datafusion/README.md
+
+[iceberg-catalog-glue]: crates/catalog/glue/README.md
+
+[iceberg-catalog-hms]: crates/catalog/hms/README.md
+[iceberg-catalog-hms image]: https://img.shields.io/crates/v/iceberg-catalog-hms.svg
+[iceberg-catalog-hms link]: https://crates.io/crates/iceberg-catalog-hms
+[iceberg-catalog-hms release docs]: https://docs.rs/iceberg-catalog-hms
+
+[iceberg-catalog-rest]: crates/catalog/rest/README.md
+[iceberg-catalog-rest image]: https://img.shields.io/crates/v/iceberg-catalog-rest.svg
+[iceberg-catalog-rest link]: https://crates.io/crates/iceberg-catalog-rest
+[iceberg-catalog-rest release docs]: https://docs.rs/iceberg-catalog-rest
## Contribute
-Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are some ways to go.
+Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are
+some ways to go.
Review Comment:
Maybe good to include the ASF as well.
```suggestion
Apache Iceberg is an active open-source project, governed under the Apache Software Foundation (ASF). We are always open to people who want to use or contribute to it. Here are some ways to get involved.
```
This also includes Scott's suggestion.
##########
README.md:
##########
@@ -17,89 +17,62 @@
~ under the License.
-->
-# Apache Iceberg Rust
-
-Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/).
-
-## Roadmap
-
-### Catalog
-
-| Catalog Type | Status |
-| ------------ | ----------- |
-| Rest | Done |
-| Hive | Done |
-| Sql | In Progress |
-| Glue | Done |
-| DynamoDB | Not Started |
-
-### FileIO
-
-| FileIO Type | Status |
-| ----------- | ----------- |
-| S3 | Done |
-| Local File | Done |
-| GCS | Not Started |
-| HDFS | Not Started |
-
-Our `FileIO` is powered by [Apache OpenDAL](https://github.com/apache/opendal), so it would be quite easy to
-expand to other service.
-
-### Table API
-
-#### Reader
-
-| Feature | Status |
-| ---------------------------------------------------------- | ----------- |
-| File based task planning | Done |
-| Size based task planning | Not started |
-| Filter pushdown(manifest evaluation, partition prunning) | In Progress |
-| Apply deletions, including equality and position deletions | Not started |
-| Read into arrow record batch | In Progress |
-| Parquet file support | Done |
-| ORC file support | Not started |
-
-#### Writer
-
-| Feature | Status |
-| ------------------------ | ----------- |
-| Data writer | Not started |
-| Equality deletion writer | Not started |
-| Position deletion writer | Not started |
-| Partitioned writer | Not started |
-| Upsert writer | Not started |
-| Parquet file support | Not started |
-| ORC file support | Not started |
-
-#### Transaction
-
-| Feature | Status |
-| --------------------- | ----------- |
-| Schema evolution | Not started |
-| Update partition spec | Not started |
-| Update properties | Not started |
-| Replace sort order | Not started |
-| Update location | Not started |
-| Append files | Not started |
-| Rewrite files | Not started |
-| Rewrite manifests | Not started |
-| Overwrite files | Not started |
-| Row level updates | Not started |
-| Replace partitions | Not started |
-| Snapshot management | Not started |
-
-### Integrations
-
-We will add integrations with other rust based data systems, such as polars, datafusion, etc.
+# Apache Iceberg™ Rust
+
+
+
+Rust implementation of [Apache Iceberg™](https://iceberg.apache.org/).
+
+Working on [v0.3.0 Release Milestone](https://github.com/apache/iceberg-rust/milestone/2)
+
+## Components
+
+The Apache Iceberg Rust project is composed of the following components:
+
+| Name | Release | Docs |
+|------------------------|------------------------------------------------------------|------------------------------------------------------|
+| [iceberg] | [![iceberg image]][iceberg link] | [![docs release]][iceberg release docs] |
+| [iceberg-datafusion] | - | - |
+| [iceberg-catalog-glue] | - | - |
+| [iceberg-catalog-hms] | [![iceberg-catalog-hms image]][iceberg-catalog-hms link] | [![docs release]][iceberg-catalog-hms release docs] |
+| [iceberg-catalog-rest] | [![iceberg-catalog-rest image]][iceberg-catalog-rest link] | [![docs release]][iceberg-catalog-rest release docs] |
+
+[docs release]: https://img.shields.io/badge/docs-release-blue
+[iceberg]: crates/iceberg/README.md
+[iceberg image]: https://img.shields.io/crates/v/iceberg.svg
+[iceberg link]: https://crates.io/crates/iceberg
+[iceberg release docs]: https://docs.rs/iceberg
+
+[iceberg-datafusion]: crates/integrations/datafusion/README.md
+
+[iceberg-catalog-glue]: crates/catalog/glue/README.md
+
+[iceberg-catalog-hms]: crates/catalog/hms/README.md
+[iceberg-catalog-hms image]: https://img.shields.io/crates/v/iceberg-catalog-hms.svg
+[iceberg-catalog-hms link]: https://crates.io/crates/iceberg-catalog-hms
+[iceberg-catalog-hms release docs]: https://docs.rs/iceberg-catalog-hms
+
+[iceberg-catalog-rest]: crates/catalog/rest/README.md
+[iceberg-catalog-rest image]: https://img.shields.io/crates/v/iceberg-catalog-rest.svg
+[iceberg-catalog-rest link]: https://crates.io/crates/iceberg-catalog-rest
+[iceberg-catalog-rest release docs]: https://docs.rs/iceberg-catalog-rest
## Contribute
-Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are some ways to go.
+Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are
+some ways to go.
- Start with [Contributing Guide](CONTRIBUTING.md).
- Submit [Issues](https://github.com/apache/iceberg-rust/issues/new) for bug report or feature requests.
-- Discuss at [dev mailing list](mailto:dev@iceberg.apache.org) ([subscribe](<mailto:dev-subscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20subscribe)>) / [unsubscribe](<mailto:dev-unsubscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20unsubscribe)>) / [archives](https://lists.apache.org/list.html?dev@iceberg.apache.org))
-- Talk to community directly at [Slack #rust channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A).
+- Discuss
+ at [dev mailing list](mailto:dev@iceberg.apache.org) ([subscribe](<mailto:dev-subscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20subscribe)>) / [unsubscribe](<mailto:dev-unsubscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20unsubscribe)>) / [archives](https://lists.apache.org/list.html?dev@iceberg.apache.org))
+- Talk to community directly
+ at [Slack #rust channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A).
+
Review Comment:
```suggestion
The Apache Iceberg community is built on the principles described in the [Apache Way](https://www.apache.org/theapacheway/index.html) and all who engage with the community are expected to be respectful, open, come with the best interests of the community in mind, and abide by the Apache Foundation [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: Refactor the README to be more user-oriented [iceberg-rust]
Posted by "liurenjie1024 (via GitHub)" <gi...@apache.org>.
liurenjie1024 commented on PR #444:
URL: https://github.com/apache/iceberg-rust/pull/444#issuecomment-2211700081
Let's wait to see if @Fokko have any suggestions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org