docs: explain the value of deltalake on first page of docs #3017
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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. |
braaannigan
force-pushed
the
why-use-deltalake
branch
from
daa297f
to
476d722
Compare
braaannigan
changed the title
added 5 commits
November 22, 2024 10:08
Signed-off-by: Liam Brannigan <l.brannigan@analyticsengines.com>
Signed-off-by: Liam Brannigan <l.brannigan@analyticsengines.com>
Signed-off-by: Liam Brannigan <l.brannigan@analyticsengines.com>
Signed-off-by: Liam Brannigan <l.brannigan@analyticsengines.com>
ion-elgreco
force-pushed
the
why-use-deltalake
branch
from
476d722
to
6946514
Compare
ion-elgreco
reviewed
Nov 22, 2024
ion-elgreco
approved these changes
Nov 22, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3017 +/- ##
==========================================
+ Coverage 72.47% 72.48% +0.01%
==========================================
Files 128 128
Lines 40831 40831
Branches 40831 40831
==========================================
+ Hits 29591 29598 +7
- Misses 9355 9357 +2
+ Partials 1885 1876 -9 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The PR sets a proposed change to the text on the first page of the docs. When I arrived on these pages as a new user I found the current text did not answer the basic questions I had about the library. I've proposed a new text, though I'm happy to take on feedback.
Note: there is some overlap with the ideas on the "Why use delta lake" page. In essence I'm proposing having a quick summary of those concepts and a quickstart guide on the first page as I feel that for potential new users who have no familiarity with delta spark the current front page goes into more technical detail on that relationship than necessary.
I'd like to do a follow-on where the Why use delta lake page. I'm also wondering whether quickstart should be on a separate page in this section to make it easy to find.
Related Issue(s)