Skip to content

Commit 666c58b

Browse files
authored
docs: clean up stale and broken documentation links (#2287)
1 parent ae2d780 commit 666c58b

3 files changed

Lines changed: 8 additions & 18 deletions

File tree

docs/source/contributors-guide/architecture.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ than for data science.
3333
### Arrow-native
3434

3535
Ballista uses the Apache Arrow memory format during query execution, and Apache Arrow IPC format on disk for
36-
shuffle files and for exchanging data between executors. Queries can be submitted using the Arrow Flight SQL API
37-
and the Arrow Flight SQL JDBC Driver.
36+
shuffle files and for exchanging data between executors. Queries can be submitted from Rust and Python clients
37+
or the Ballista CLI.
3838

3939
### Language Agnostic
4040

4141
Although most of the implementation code is written in Rust, the scheduler and executor APIs are based on open
42-
standards, including protocol buffers, gRPC, Apache Arrow IPC, and Apache Arrow Flight SQL.
42+
standards, including protocol buffers, gRPC, Apache Arrow IPC, and Apache Arrow Flight.
4343

4444
This language agnostic approach will allow Ballista to eventually support UDFs in languages other than Rust,
4545
including Wasm.
@@ -72,7 +72,6 @@ between the executor(s) and the scheduler for fetching tasks and reporting task
7272
The scheduler provides the following interfaces:
7373

7474
- gRPC service for submitting and managing jobs
75-
- Flight SQL API
7675
- REST API for monitoring jobs
7776

7877
Jobs are submitted to the scheduler's gRPC service from a client context, either in the form of a logical query
@@ -96,8 +95,6 @@ There are multiple clients available for submitting jobs to a Ballista cluster:
9695
context with support for SQL and DataFrame operations.
9796
- The [ballista crate](https://crates.io/crates/ballista) provides a native Rust session context with support for
9897
SQL and DataFrame operations.
99-
- The [Flight SQL JDBC driver](https://arrow.apache.org/docs/java/flight_sql_jdbc_driver.html) can be used from
100-
popular SQL tools to execute SQL queries against a cluster.
10198

10299
## Distributed Query Scheduling
103100

docs/source/contributors-guide/code-organization.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This section provides links to the source code for major areas of functionality.
2323

2424
### ballista-core crate
2525

26-
- [Crate Source](https://github.com/apache/datafusion-ballista/blob/main/ballista/core)
26+
- [Crate Source](https://github.com/apache/datafusion-ballista/tree/main/ballista/core)
2727
- [Protocol Buffer Definition](https://github.com/apache/datafusion-ballista/blob/main/ballista/core/proto/ballista.proto)
2828
- [Execution Plans](https://github.com/apache/datafusion-ballista/tree/main/ballista/core/src/execution_plans)
2929
- [Ballista Client](https://github.com/apache/datafusion-ballista/blob/main/ballista/core/src/client.rs)
@@ -33,7 +33,6 @@ This section provides links to the source code for major areas of functionality.
3333
- [Crate Source](https://github.com/apache/datafusion-ballista/tree/main/ballista/scheduler)
3434
- [Distributed Query Planner](https://github.com/apache/datafusion-ballista/blob/main/ballista/scheduler/src/planner.rs)
3535
- [gRPC Service](https://github.com/apache/datafusion-ballista/blob/main/ballista/scheduler/src/scheduler_server/grpc.rs)
36-
- [Flight SQL Service](https://github.com/apache/datafusion-ballista/blob/main/ballista/scheduler/src/flight_sql.rs)
3736
- [REST API](https://github.com/apache/datafusion-ballista/tree/main/ballista/scheduler/src/api)
3837
- [Prometheus Integration](https://github.com/apache/datafusion-ballista/blob/main/ballista/scheduler/src/metrics/prometheus.rs)
3938

@@ -46,9 +45,8 @@ This section provides links to the source code for major areas of functionality.
4645
### ballista crate
4746

4847
- [Crate Source](https://github.com/apache/datafusion-ballista/tree/main/ballista/client)
49-
- [Context](https://github.com/apache/datafusion-ballista/blob/main/ballista/client/src/context.rs)
48+
- [Context Extensions](https://github.com/apache/datafusion-ballista/blob/main/ballista/client/src/extension.rs)
5049

5150
### PyBallista
5251

5352
- [Source](https://github.com/apache/datafusion-ballista/tree/main/python)
54-
- [Context](https://github.com/apache/datafusion-ballista/blob/main/python/src/context.rs)

docs/source/user-guide/introduction.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,10 @@ Ballista is a distributed compute platform primarily implemented in Rust, and po
2424
Ballista has both scheduler and an executor component processes that are standard Rust executables.
2525

2626
Dockerfiles are also provided to build images for use in containerized environments, such as Docker, Docker Compose,
27-
and Kubernetes. See the [deployment guide](deployment.md) for more information.
27+
and Kubernetes. See the [deployment guide](deployment/) for more information.
2828

29-
SQL and DataFrame queries can be submitted from Python and Rust, and SQL queries can be submitted via the Arrow
30-
Flight SQL JDBC driver, supporting your favorite JDBC compliant tools such as [DataGrip](datagrip)
31-
or [tableau](tableau). For setup instructions, please see the [FlightSQL guide](flightsql.md).
29+
SQL and DataFrame queries can be submitted from Python and Rust, and SQL queries can also be submitted using the
30+
Ballista CLI.
3231

3332
## How does this compare to Apache Spark?
3433

@@ -44,7 +43,3 @@ Although Ballista is largely inspired by Apache Spark, there are some key differ
4443
distributed compute.
4544
- The use of Apache Arrow as the memory model and network protocol means that data can be exchanged between executors
4645
in any programming language with minimal serialization overhead.
47-
48-
[deployment](./deployment)
49-
[datagrip](https://www.jetbrains.com/datagrip/)
50-
[tableau](https://help.tableau.com/current/pro/desktop/en-us/examples_otherdatabases_jdbc.htm)

0 commit comments

Comments
 (0)