Skip to content

Commit f2e0821

Browse files
compheadandygrove
authored andcommitted
Doc: Modify docs to fix old naming (apache#10199)
* fix docs on datafusion names * fix code * fmt * Update dev/release/README.md Co-authored-by: Andy Grove <[email protected]> * Update dev/release/README.md Co-authored-by: Andy Grove <[email protected]> * Update dev/release/README.md Co-authored-by: Andy Grove <[email protected]> --------- Co-authored-by: Andy Grove <[email protected]>
1 parent c54c4e5 commit f2e0821

File tree

10 files changed

+19
-20
lines changed

10 files changed

+19
-20
lines changed

datafusion-cli/src/catalog.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -345,10 +345,9 @@ mod tests {
345345
if cfg!(windows) { "USERPROFILE" } else { "HOME" },
346346
test_home_path,
347347
);
348-
let input =
349-
"~/Code/arrow-datafusion/benchmarks/data/tpch_sf1/part/part-0.parquet";
348+
let input = "~/Code/datafusion/benchmarks/data/tpch_sf1/part/part-0.parquet";
350349
let expected = format!(
351-
"{}{}Code{}arrow-datafusion{}benchmarks{}data{}tpch_sf1{}part{}part-0.parquet",
350+
"{}{}Code{}datafusion{}benchmarks{}data{}tpch_sf1{}part{}part-0.parquet",
352351
test_home_path,
353352
MAIN_SEPARATOR,
354353
MAIN_SEPARATOR,

datafusion-examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To run the examples, use the `cargo run` command, such as:
3131

3232
```bash
3333
git clone https://github.com/apache/datafusion
34-
cd arrow-datafusion
34+
cd datafusion
3535
# Download test data
3636
git submodule update --init
3737

datafusion-examples/examples/flight/flight_sql_server.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ macro_rules! status {
7373
///
7474
/// JDBC connection string: "jdbc:arrow-flight-sql://127.0.0.1:50051/"
7575
///
76-
/// Based heavily on Ballista's implementation: https://github.com/apache/arrow-ballista/blob/main/ballista/scheduler/src/flight_sql.rs
76+
/// Based heavily on Ballista's implementation: https://github.com/apache/datafusion-ballista/blob/main/ballista/scheduler/src/flight_sql.rs
7777
/// and the example in arrow-rs: https://github.com/apache/arrow-rs/blob/master/arrow-flight/examples/flight_sql_server.rs
7878
///
7979
#[tokio::main]

datafusion/sqllogictest/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ query <type_string> <sort_mode>
225225
<expected_result>
226226
```
227227

228-
- `test_name`: Uniquely identify the test name (arrow-datafusion only)
228+
- `test_name`: Uniquely identify the test name (Datafusion only)
229229
- `type_string`: A short string that specifies the number of result columns and the expected datatype of each result
230230
column. There is one character in the <type_string> for each result column. The characters codes are:
231231
- 'B' - **B**oolean,

datafusion/sqllogictest/src/engines/datafusion_engine/normalize.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,21 +142,21 @@ fn normalize_paths(mut row: Vec<String>) -> Vec<String> {
142142
fn workspace_root() -> &'static object_store::path::Path {
143143
static WORKSPACE_ROOT_LOCK: OnceLock<object_store::path::Path> = OnceLock::new();
144144
WORKSPACE_ROOT_LOCK.get_or_init(|| {
145-
// e.g. /Software/arrow-datafusion/datafusion/core
145+
// e.g. /Software/datafusion/datafusion/core
146146
let dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
147147

148-
// e.g. /Software/arrow-datafusion/datafusion
148+
// e.g. /Software/datafusion/datafusion
149149
let workspace_root = dir
150150
.parent()
151151
.expect("Can not find parent of datafusion/core")
152-
// e.g. /Software/arrow-datafusion
152+
// e.g. /Software/datafusion
153153
.parent()
154154
.expect("parent of datafusion")
155155
.to_string_lossy();
156156

157157
let sanitized_workplace_root = if cfg!(windows) {
158-
// Object store paths are delimited with `/`, e.g. `D:/a/arrow-datafusion/arrow-datafusion/testing/data/csv/aggregate_test_100.csv`.
159-
// The default windows delimiter is `\`, so the workplace path is `D:\a\arrow-datafusion\arrow-datafusion`.
158+
// Object store paths are delimited with `/`, e.g. `/datafusion/datafusion/testing/data/csv/aggregate_test_100.csv`.
159+
// The default windows delimiter is `\`, so the workplace path is `datafusion\datafusion`.
160160
workspace_root
161161
.replace(std::path::MAIN_SEPARATOR, object_store::path::DELIMITER)
162162
} else {

dev/release/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ Here is my vote:
223223
+1
224224
225225
[1]: https://github.com/apache/datafusion/tree/a5dd428f57e62db20a945e8b1895de91405958c4
226-
[2]: https://dist.apache.org/repos/dist/dev/arrow/apache-arrow-datafusion-5.1.0
226+
[2]: https://dist.apache.org/repos/dist/dev/arrow/apache-datafusion-5.1.0
227227
[3]: https://github.com/apache/datafusion/blob/a5dd428f57e62db20a945e8b1895de91405958c4/CHANGELOG.md
228228
```
229229

@@ -249,7 +249,7 @@ NOTE: steps in this section can only be done by PMC members.
249249
### After the release is approved
250250

251251
Move artifacts to the release location in SVN, e.g.
252-
https://dist.apache.org/repos/dist/release/arrow/arrow-datafusion-5.1.0/, using
252+
https://dist.apache.org/repos/dist/release/datafusion/datafusion-5.1.0/, using
253253
the `release-tarball.sh` script:
254254

255255
```shell
@@ -437,7 +437,7 @@ svn ls https://dist.apache.org/repos/dist/dev/arrow | grep datafusion
437437
Delete a release candidate:
438438

439439
```bash
440-
svn delete -m "delete old DataFusion RC" https://dist.apache.org/repos/dist/dev/arrow/apache-arrow-datafusion-7.1.0-rc1/
440+
svn delete -m "delete old DataFusion RC" https://dist.apache.org/repos/dist/dev/datafusion/apache-datafusion-7.1.0-rc1/
441441
```
442442

443443
#### Deleting old releases from `release` svn
@@ -453,7 +453,7 @@ svn ls https://dist.apache.org/repos/dist/release/arrow | grep datafusion
453453
Delete a release:
454454

455455
```bash
456-
svn delete -m "delete old DataFusion release" https://dist.apache.org/repos/dist/release/arrow/arrow-datafusion-7.0.0
456+
svn delete -m "delete old DataFusion release" https://dist.apache.org/repos/dist/release/datafusion/datafusion-7.0.0
457457
```
458458

459459
### Publish the User Guide to the Arrow Site

docs/source/contributor-guide/communication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ We use the Slack and Discord platforms for informal discussions and coordination
3737
meet other contributors and get guidance on where to contribute. It is important to note that any technical designs and
3838
decisions are made fully in the open, on GitHub.
3939

40-
Most of us use the `#arrow-datafusion` and `#arrow-rust` channels in the [ASF Slack workspace](https://s.apache.org/slack-invite) .
40+
Most of us use the `#datafusion` and `#arrow-rust` channels in the [ASF Slack workspace](https://s.apache.org/slack-invite) .
4141
Unfortunately, due to spammers, the ASF Slack workspace requires an invitation to join. To get an invitation,
4242
request one in the `Arrow Rust` channel of the [Arrow Rust Discord server](https://discord.gg/Qw5gKqHxUM).
4343

docs/source/user-guide/example-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ backtrace: 0: std::backtrace_rs::backtrace::libunwind::trace
274274
3: std::backtrace::Backtrace::capture
275275
at /rustc/5680fa18feaa87f3ff04063800aec256c3d4b4be/library/std/src/backtrace.rs:298:9
276276
4: datafusion_common::error::DataFusionError::get_back_trace
277-
at /arrow-datafusion/datafusion/common/src/error.rs:436:30
277+
at /datafusion/datafusion/common/src/error.rs:436:30
278278
5: datafusion_sql::expr::function::<impl datafusion_sql::planner::SqlToRel<S>>::sql_function_to_expr
279279
............
280280
```

docs/source/user-guide/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ DataFusion is a library for executing queries in-process using the Apache Arrow
2828
model and computational kernels. It is designed to run within a single process, using threads
2929
for parallel query execution.
3030

31-
[Ballista](https://github.com/apache/arrow-ballista) is a distributed compute platform built on DataFusion.
31+
[Ballista](https://github.com/apache/datafusion-ballista) is a distributed compute platform built on DataFusion.
3232

3333
# How does DataFusion Compare with `XYZ`?
3434

docs/source/user-guide/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Here are some active projects using DataFusion:
9595
<!-- "Active" means github repositories that had at least one commit in the last 6 months -->
9696

9797
- [Arroyo](https://github.com/ArroyoSystems/arroyo) Distributed stream processing engine in Rust
98-
- [Ballista](https://github.com/apache/arrow-ballista) Distributed SQL Query Engine
98+
- [Ballista](https://github.com/apache/datafusion-ballista) Distributed SQL Query Engine
9999
- [Comet](https://github.com/apache/datafusion-comet) Apache Spark native query execution plugin
100100
- [CnosDB](https://github.com/cnosdb/cnosdb) Open Source Distributed Time Series Database
101101
- [Cube Store](https://github.com/cube-js/cube.js/tree/master/rust)
@@ -129,7 +129,7 @@ Here are some less active projects that used DataFusion:
129129
- [Flock](https://github.com/flock-lab/flock)
130130
- [Tensorbase](https://github.com/tensorbase/tensorbase)
131131

132-
[ballista]: https://github.com/apache/arrow-ballista
132+
[ballista]: https://github.com/apache/datafusion-ballista
133133
[blaze]: https://github.com/blaze-init/blaze
134134
[cloudfuse buzz]: https://github.com/cloudfuse-io/buzz-rust
135135
[cnosdb]: https://github.com/cnosdb/cnosdb

0 commit comments

Comments
 (0)