Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve repository readme #5752

Merged
merged 1 commit into from
May 13, 2024
Merged

Improve repository readme #5752

merged 1 commit into from
May 13, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented May 11, 2024

Which issue does this PR close?

Rationale for this change

While working on #5737 and #5750 I noticed a few improvements that could be made to the repository readme.

What changes are included in this PR?

Refine description and add more links to readme

See the rendered version here: https://github.com/alamb/arrow-rs/blob/alamb/readme/README.md

Are there any user-facing changes?

Docs

| Crate | Description | Documentation |
| -------------- | --------------------------------------- | ----------------------------- |
| [`datafusion`] | In-memory query engine with SQL support | [(README)][datafusion-readme] |
| [`ballista`] | Distributed query execution | [(README)][ballista-readme] |
Copy link
Member

Choose a reason for hiding this comment

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

Hi, do you think it's a good idea to add object_store_opendal here as an integration to object_store?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds like a good idea to me -- is it mature enough to steer people to? The crates.io page makes it unclear

https://crates.io/crates/object_store_opendal

Screenshot 2024-05-11 at 6 32 25 AM

Copy link
Member

Choose a reason for hiding this comment

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

Sounds like a good idea to me -- is it mature enough to steer people to? The crates.io page makes it unclear

Nice catch. I will improve this part and raising a PR later.

Copy link
Contributor Author

@alamb alamb May 11, 2024

Choose a reason for hiding this comment

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

Sounds good, thank you

@tustvold tustvold merged commit 3566328 into apache:master May 13, 2024
10 checks passed
@alamb alamb added the documentation Improvements or additions to documentation label Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants