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

various documentation updates #3005

Closed
wants to merge 12 commits into from

Conversation

kmitchener
Copy link
Contributor

@kmitchener kmitchener commented Aug 1, 2022

Which issue does this PR close?

Closes #1352
Closes #3001
Closes #2866
You can also close #2558 and close #1813 though they're not directly related to this PR

Rationale for this change

What changes are included in this PR?

Are there any user-facing changes?

The docs are slightly better.

fix some links and docs
fix docker build for datafusion-cli and update docs
improve left nav link naming for clarity
consolidated the documentation for the CLI into one page per issue apache#1352
fix the CSV schema inference in datafusion-cli docs per apache#3001
@github-actions github-actions bot added core Core DataFusion crate documentation Improvements or additions to documentation labels Aug 1, 2022
@kmitchener kmitchener changed the title remove python docs (they're added to the python project in PR#) various documentation updates Aug 1, 2022
@codecov-commenter
Copy link

codecov-commenter commented Aug 1, 2022

Codecov Report

Merging #3005 (210012e) into master (9a5f17e) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           master    #3005    +/-   ##
========================================
  Coverage   85.84%   85.85%            
========================================
  Files         283      289     +6     
  Lines       51658    51890   +232     
========================================
+ Hits        44347    44550   +203     
- Misses       7311     7340    +29     
Impacted Files Coverage Δ
datafusion/physical-expr/src/aggregate/build_in.rs 89.92% <0.00%> (-0.26%) ⬇️
datafusion/proto/src/to_proto.rs 53.03% <0.00%> (-0.19%) ⬇️
datafusion/core/tests/sql/mod.rs 98.10% <0.00%> (-0.17%) ⬇️
datafusion/proto/src/from_proto.rs 35.53% <0.00%> (-0.05%) ⬇️
datafusion/physical-expr/src/aggregate/stddev.rs 96.03% <0.00%> (-0.04%) ⬇️
...afusion/physical-expr/src/aggregate/correlation.rs 97.95% <0.00%> (-0.02%) ⬇️
datafusion/physical-expr/src/aggregate/variance.rs 98.30% <0.00%> (-0.02%) ⬇️
...tafusion/physical-expr/src/aggregate/covariance.rs 98.70% <0.00%> (-0.01%) ⬇️
datafusion/core/tests/sql/timestamp.rs 100.00% <0.00%> (ø)
datafusion/core/tests/parquet_pruning.rs 99.43% <0.00%> (ø)
... and 22 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

remove duplicate example usage, instead directing user to other page for examples
add reference to talk/slides from summit
README.md Outdated Show resolved Hide resolved
@kmitchener
Copy link
Contributor Author

Updated per review. I'm not done with this. Still working on organizing the content and creating new content.

@andygrove
Copy link
Member

@kmitchener What do you think about breaking some of these changes out into smaller PRs? For example, the formatting changes to the roadmap could be reviewed as a standalone change. This might make it easier to review the more substantive changes here.

@kmitchener
Copy link
Contributor Author

@andygrove sure, yes, I can do that. I got a little exploratory and just kept making changes, unsure how they would work out. I'll submit separate PR for the simple cleanups and see how I can break this up further for easier review. I've been away from this for a few days, maybe fresh eyes will help.

@kmitchener
Copy link
Contributor Author

closing this PR as it was exploratory and too big and all it's changes are going in other PRs

@kmitchener kmitchener closed this Aug 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core DataFusion crate documentation Improvements or additions to documentation
Projects
None yet
3 participants