docs: add the examples crate for rust

[gohalo]

Description

How are the changes test-covered

• N/A
• Automated tests (unit and/or integration tests)
• Manual tests
  • Details are described below

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@f56603b). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #122   +/-   ##
=======================================
  Coverage        ?   87.60%           
=======================================
  Files           ?       14           
  Lines           ?      702           
  Branches        ?        0           
=======================================
  Hits            ?      615           
  Misses          ?       87           
  Partials        ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[codope]

Thanks for adding an example. I am assuming you plan to build more on top of this.

@xushiyan Could you please review as well?

[codope]

@xushiyan Could you confirm the dependencies are correct?

[gohalo]

maybe only the macros features will work.

[xushiyan]

@gohalo thanks for raising this. While an "examples" crate can be helpful, we won't merge nice-to-have PRs until we can justify the value of the code. As of now, it's a simple example repeating the one on the readme. What other examples could we add there in future? How do we expect users to use and benefit from it? How can the example code be tested properly so we can easily evolve it? If we are to create a website, how can we consolidate the code here and the examples to show on website?

In short, I'm highlighting that we need to make a proper plan or design for any major addition to the codebase. You may want to create an issue for design, plan, and discussion first.

[gohalo]

@gohalo thanks for raising this. While an "examples" crate can be helpful, we won't merge nice-to-have PRs until we can justify the value of the code. As of now, it's a simple example repeating the one on the readme. What other examples could we add there in future? How do we expect users to use and benefit from it? How can the example code be tested properly so we can easily evolve it? If we are to create a website, how can we consolidate the code here and the examples to show on website?

It's just a startup example for now. Recently, i'm trying to build a local minio env, and also working on create the table, support writing and so on. Maybe the examples will be a good startup for user and especilly for developer to run some basic example.

In short, I'm highlighting that we need to make a proper plan or design for any major addition to the codebase. You may want to create an issue for design, plan, and discussion first.

Just open an issue #123

[xushiyan]

we should evolve the changes such that the examples are embedded in the rust module level docs and shown in docs.rs like https://docs.rs/pyo3/latest/pyo3/#example-using-python-from-rust
this is more canonical way of showing examples, and automatically we'll get the example code tested by doc testing.

echoing the comment here #123 (comment)

[xushiyan]

Thanks for the PR. While we're adding module level examples like

hudi-rs/crates/core/src/table/mod.rs

Line 24 in 4176c29

//! **Example**

we also have demo apps that ran as integ tests: https://github.com/apache/hudi-rs/tree/main/demo

closing this now.