Skip to content

Conversation

@andygrove
Copy link
Member

@andygrove andygrove commented Aug 28, 2021

Which issue does this PR close?

Closes #862 and #953.

Rationale for this change

Improve user guide for the next release

What changes are included in this PR?

  • Added CREATE EXTERNAL TABLE examples to sql/ddl.md
  • Remove Ballista architecture diagram (it overpromises and could cause confusion)
  • Rename distributed/standalone.md to distributed/docker.md since it describes deployment with Docker
  • Added new distributed/cargo-install.md explaining how to install Ballista using cargo install
  • Added code samples to distributed/client-rust.md
  • Update DataFusion and Ballista version numbers
  • Add section for DataFusion CLI
  • Update docker guide after testing content
  • Update docker-compose guide after testing content
  • Update k8s guide after testing content
  • Added instructions for setting up port forwarding in k8s

Are there any user-facing changes?

No.

@andygrove andygrove changed the title Fix various issues with user guide Improve User Guide Aug 28, 2021
@andygrove andygrove marked this pull request as draft August 28, 2021 15:35
@andygrove andygrove linked an issue Aug 28, 2021 that may be closed by this pull request
@andygrove
Copy link
Member Author

@houqp How do we ensure version numbers get updated in the user guide during the release process?

@andygrove andygrove marked this pull request as ready for review August 28, 2021 16:44
@andygrove andygrove requested review from Dandandan, alamb and houqp August 28, 2021 16:45
@houqp
Copy link
Member

houqp commented Aug 28, 2021

version update should be taken care by https://github.com/apache/arrow-datafusion/blob/master/dev/update_ballista_versions.py and https://github.com/apache/arrow-datafusion/blob/master/dev/update_datafusion_versions.py. I can help with the automation later next week.

@andygrove andygrove merged commit e52abb3 into apache:master Aug 31, 2021
@andygrove andygrove deleted the user-guide branch August 31, 2021 03:20
matthewmturner added a commit to matthewmturner/arrow-datafusion that referenced this pull request Sep 15, 2021
@houqp houqp added ballista documentation Improvements or additions to documentation labels Nov 4, 2021
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.

Update user guide Add datafusion-cli documentation to the user guide

2 participants