docs: update Readme #1440
docs: update Readme #1440
Conversation
|
ACTION NEEDED delta-rs follows the Conventional Commits specification for release automation. The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification. |
There was a problem hiding this comment.
What do you think of adding a "Powered By" section and listing Apache Arrow and DataFusion?
There was a problem hiding this comment.
+1 especially from the context that we're updating delta.rs to keep up with them, eh?! ;)
There was a problem hiding this comment.
should we then also submit a PR to the official arrow "pwered_by" section?
| <a target="_blank" href="https://go.delta.io/slack"> | ||
| <img alt="#delta-rs in the Delta Lake Slack workspace" src="https://img.shields.io/badge/slack-delta-blue.svg?logo=slack&style=flat-square&color=F75101"> | ||
| </a> |
There was a problem hiding this comment.
Could we add back a "Get involved section"?
Could list:
- Join the slack workspace (the button is nice, but it's kind of small)
- Report an issue
- Looking to contribute? See our list of good first issues (https://github.com/delta-io/delta-rs/contribute)
There was a problem hiding this comment.
+1 especially from the context that we're updating delta.rs to keep up with them, eh?! ;)
| | Storage | Rust | Python | Comment | | ||
| | -------------------- | :-------------------: | :-------------------: | ----------------------------------- | | ||
| | Local | ![done] | ![done] | | | ||
| | S3 - AWS | ![done] | ![done] | requires lock for concurrent writes | |
There was a problem hiding this comment.
Should we point to the docs to explain how to spin up DynamoDB for the lock?
README.md
Outdated
| </a> | ||
| </p> | ||
|
|
||
| The delta-rs project aims to unlock the power of the Deltalake for as many users and projects as possible |
There was a problem hiding this comment.
Please update to "Delta Lake"
README.md
Outdated
|
|
||
| The delta-rs project aims to unlock the power of the Deltalake for as many users and projects as possible | ||
| by providing native low level APIs aimed at developers and integrators, as well as a high level operations | ||
| API that lets you query, inspect, and operate your Deltalake with ease. |
There was a problem hiding this comment.
Please update to "Delta Lake"
README.md
Outdated
|
|
||
| ## Quick Start | ||
|
|
||
| The deltalake library aim to adopt familiar patterns from other libraries in data processing, |
There was a problem hiding this comment.
Suggest either "The Delta Lake library aims to..." or "The deltalake library aims to..."
Co-authored-by: Will Jones <[email protected]>
|
Looks like some great improvements! |
github-actions
bot
added
the
documentation
Co-authored-by: Will Jones <[email protected]>
README.md
Outdated
| | Writer Version | Requirement | Status | | ||
| | -------------- | --------------------------------------------- | :------------------: | | ||
| | Version 2 | Append Only Tables | [![open]][roadmap] | | ||
| | Version 2 | Column Invatiants | ![done] | |
There was a problem hiding this comment.
Little typo here (Invatiants => Invariants)
Description
With summit coming up I thought we might update our README, since delta-rs has evolved quite a bit since the README was first written...
Just opening the Draft to get feedback on the general "patterns" i.e. how the tables are formatted, how detailed we want to show the features and mostly the looks of the header.
Also hoping our community experts may have some content they wat to add here 😆.
cc @dennyglee @MrPowers @wjones127 @rtyler @houqp @fvaleye