Skip to content

Commit 1702d6c

Browse files
authored
Make it easer for developers to find Ballista documentation (#330)
1 parent 874132e commit 1702d6c

8 files changed

+18
-154
lines changed

DEVELOPERS.md

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121

2222
This section describes how you can get started at developing DataFusion.
2323

24+
For information on developing with Ballista, see the
25+
[Ballista developer documentation](ballista/docs/README.md).
26+
2427
### Bootstrap environment
2528

2629
DataFusion is written in Rust and it uses a standard rust toolkit:

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ logical query plans as well as a query optimizer and execution engine
3030
capable of parallel execution against partitioned data sources (CSV
3131
and Parquet) using threads.
3232

33+
DataFusion also supports distributed query execution via the
34+
[Ballista](ballista/README.md) crate.
35+
3336
## Use Cases
3437

3538
DataFusion is used to create modern, fast and efficient data

ballista/README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,14 @@ Although Ballista is largely inspired by Apache Spark, there are some key differ
5050
- The use of Apache Arrow as the memory model and network protocol means that data can be exchanged between executors
5151
in any programming language with minimal serialization overhead.
5252

53-
# Status
53+
## Status
5454

55-
The Ballista project was donated to Apache Arrow in April 2021 and work is underway to integrate more tightly with
56-
DataFusion.
57-
58-
One of the goals is to implement a common scheduler that can seamlessly scale queries across cores in DataFusion and
59-
across nodes in Ballista.
60-
61-
Ballista issues are tracked in ASF JIRA [here](https://issues.apache.org/jira/issues/?jql=project%20%3D%20ARROW%20AND%20component%20%3D%20%22Rust%20-%20Ballista%22)
55+
Ballista was [donated](https://arrow.apache.org/blog/2021/04/12/ballista-donation/) to the Apache Arrow project in
56+
April 2021 and should be considered experimental.
6257

58+
## Getting Started
6359

60+
The [Ballista Developer Documentation](docs/README.md) and the
61+
[DataFusion User Guide](https://github.com/apache/arrow-datafusion/tree/master/docs/user-guide) are currently the
62+
best sources of information for getting started with Ballista.
6463

ballista/docs/README.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
This directory contains documentation for developers that are contributing to Ballista. If you are looking for
2222
end-user documentation for a published release, please start with the
23-
[Ballista User Guide](https://ballistacompute.org/docs/) instead.
23+
[DataFusion User Guide](../../docs/user-guide) instead.
2424

2525
## Architecture & Design
2626

@@ -29,9 +29,6 @@ end-user documentation for a published release, please start with the
2929

3030
## Build, Test, Release
3131

32-
- Setting up a [Rust development environment](dev-env-rust.md).
33-
- Setting up a [Java development environment](dev-env-jvm.md).
34-
- Notes on building [Rust docker images](rust-docker.md)
32+
- Setting up a [development environment](dev-env.md).
3533
- [Integration Testing](integration-testing.md)
36-
- [Release process](release-process.md)
3734

File renamed without changes.

ballista/docs/integration-testing.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,11 @@
1818
-->
1919
# Integration Testing
2020

21-
Ballista has a [benchmark crate](https://github.com/ballista-compute/ballista/tree/main/rust/benchmarks/tpch) which is
22-
derived from TPC-H and this is currently the main form of integration testing.
21+
We use the [DataFusion Benchmarks](https://github.com/apache/arrow-datafusion/tree/master/benchmarks) for integration
22+
testing.
2323

24-
The following command can be used to run the integration tests.
24+
The integration tests can be executed by running the following command from the root of the DataFusion repository.
2525

2626
```bash
2727
./dev/integration-tests.sh
2828
```
29-
30-
Please refer to the
31-
[benchmark documentation](https://github.com/ballista-compute/ballista/blob/main/rust/benchmarks/tpch/README.md)
32-
for more information.

ballista/docs/release-process.md

-68
This file was deleted.

ballista/docs/rust-docker.md

-66
This file was deleted.

0 commit comments

Comments
 (0)