Skip to content

User Guide: Combine CLI pages - #3133

Merged
alamb merged 1 commit into
apache:masterfrom
andygrove:combine-cli-docs
Aug 15, 2022
Merged

User Guide: Combine CLI pages#3133
alamb merged 1 commit into
apache:masterfrom
andygrove:combine-cli-docs

Conversation

@andygrove

@andygroveandygrove commented Aug 13, 2022•
edited
Loading

Copy link
Copy Markdown
Member

Which issue does this PR close?

Closes#1352

Rationale for this change

Why have two mostly duplicate pages documenting the CLI when you can have just one?

What changes are included in this PR?

Combine pages and fix formatting

Are there any user-facing changes?

No

@andygroveandygrove added the documentation Improvements or additions to documentation label Aug 13, 2022
@github-actionsgithub-actionsBot removed the documentation Improvements or additions to documentation label Aug 13, 2022
@kmitchener

kmitchener commented Aug 13, 2022

Copy link
Copy Markdown
Contributor

This closes #1352 actually

@andygroveandygrove added the documentation Improvements or additions to documentation label Aug 13, 2022
@andygroveandygrove changed the title MINOR: User Guide: Combine CLI pagesUser Guide: Combine CLI pagesAug 13, 2022
@codecov-commenter

codecov-commenter commented Aug 13, 2022

Copy link
Copy Markdown

Codecov Report

Merging #3133 (9e433f0) into master (b1765f7) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@ Coverage Diff @@## master #3133 +/- ##
==========================================
- Coverage 85.95% 85.95% -0.01% 
==========================================
Files 291 291 Lines 52382 52382 ==========================================
- Hits 45025 45023 -2 - Misses 7357 7359 +2
Impacted FilesCoverage Δ
datafusion/expr/src/logical_plan/plan.rs77.43% <0.00%> (-0.35%)⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

This was referenced Aug 15, 2022
Merged
Closed
alamb
alamb approved these changes Aug 15, 2022
View reviewed changes

@alambalamb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I love it -- looks great thank you @andygrove

Comment threaddocs/source/user-guide/cli.md

```bash
$ datafusion-cli
DataFusion CLI v11.0.0

@alambalambAug 15, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

11.0 has a nice ring to it!

alamb
alamb reviewed Aug 15, 2022
View reviewed changes
Comment threaddocs/source/user-guide/cli.md
DataFusion CLI can also be installed via Homebrew (on MacOS). Install it as any other pre-built software like this:

```bash
brew install datafusion

@alambalambAug 15, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

TIL the homebrew formuale is still updated 🎉 10.0.0 👍

alamb@MacBook-Pro-8 datafusion-cli % brew install datafusion
Running `brew update --auto-update`...
==> Auto-updated Homebrew!
Updated 3 taps (homebrew/core, homebrew/cask and homebrew/services).
==> New Formulae
cargo-crev crytic-compile git-sync lucky-commit slither-analyzer
censys gcc@11 go@1.18 ouch solc-select
cql-proxy gcem libvatek rush-parallel svt-av1
==> New Casks
aliwangwang imhex moderndeck playcover-community yubihsm2-sdk
gittyup micromamba nanoem virtualbuddy
You have 28 outdated formulae installed.
You can upgrade them with brew upgrade
or list them with brew outdated.
==> Downloading https://ghcr.io/v2/homebrew/core/datafusion/manifests/10.0.0
######################################################################## 100.0%
==> Downloading https://ghcr.io/v2/homebrew/core/datafusion/blobs/sha256:030d1c76aabdc29cbb29c8538512ea5dd6e051
==> Downloading from https://pkg-containers.githubusercontent.com/ghcr1/blobs/sha256:030d1c76aabdc29cbb29c85385
######################################################################## 100.0%
==> Pouring datafusion--10.0.0.monterey.bottle.tar.gz
🍺 /usr/local/Cellar/datafusion/10.0.0: 9 files, 28.9MB
==> Running `brew cleanup datafusion`...

Comment threaddocs/source/user-guide/cli.md
cd arrow-datafusion/datafusion-cli
cargo build
git clone https://github.com/apache/arrow-datafusion
git checkout 8.0.0

@alambalambAug 15, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It might make sense to update this version

@alamb
alamb merged commit 49a3b00 into apache:masterAug 15, 2022
@alamb

alamb commented Aug 15, 2022

Copy link
Copy Markdown
Contributor

Thanks @kmitchener for the assist

@andygrove
andygrove deleted the combine-cli-docs branch August 15, 2022 18:51
@ursabot

ursabot commented Aug 15, 2022

Copy link
Copy Markdown

Benchmark runs are scheduled for baseline = 6509d0d and contender = 49a3b00. 49a3b00 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ec2-t3-xlarge-us-east-2] ec2-t3-xlarge-us-east-2
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on test-mac-arm] test-mac-arm
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ursa-i9-9960x] ursa-i9-9960x
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ursa-thinkcentre-m75q] ursa-thinkcentre-m75q
Buildkite builds:
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alambalambalamb approved these changes

Assignees

No one assigned

Labels

documentationImprovements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

documentations for datafusion-cli can be consolidated a bit more

5 participants

@andygrove@kmitchener@codecov-commenter@alamb@ursabot