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

Update datafusion-cli docs, split up #10078

Merged
merged 3 commits into from
Apr 16, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Apr 14, 2024

Which issue does this PR close?

Part of #7013

Rationale for this change

I was trying to configure datafusion-cli for my own purposes (see #10072) and found the documentation hard to navigate / find what I was looking for

What changes are included in this PR?

  1. Split up the datafusion cli documentation into several pages with an easier to naviagate structure
  2. Refine / improve some wording
Screenshot 2024-04-14 at 7 14 22 AM Screenshot 2024-04-14 at 7 13 11 AM

Are these changes tested?

CI

Are there any user-facing changes?

@alamb alamb added the documentation Improvements or additions to documentation label Apr 14, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Apr 14, 2024
specific language governing permissions and limitations
under the License.
-->

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All this content still existis, I just moved it into several new pages

# ==> Running `brew cleanup datafusion`...
```

## Install and run using PyPI
Copy link
Member

Choose a reason for hiding this comment

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

This isn't currently working, so we should probably remove this section.

See #9294

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in d4ab560

@alamb alamb added the documentation Improvements or additions to documentation label Apr 16, 2024
Copy link
Member

@andygrove andygrove left a comment

Choose a reason for hiding this comment

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

Thanks @alamb

@andygrove andygrove merged commit 0573f78 into apache:main Apr 16, 2024
4 checks passed
Omega359 pushed a commit to Omega359/arrow-datafusion that referenced this pull request Apr 16, 2024
* Update datafusion-cli docs, split up

* remove PiPI instructions
@alamb alamb deleted the alamb/datafusion_cli_docs branch April 16, 2024 22:04
This pull request was closed.
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.

2 participants