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

Improve comments on target user and unify intro summaries #12418

Merged
merged 1 commit into from
Sep 12, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Sep 10, 2024

Which issue does this PR close?

Related to #12357

Rationale for this change

Inspired by @phillipleblanc's comment on #12357 (comment) let's make it clearer that DataFusion is targeted at people building other systems

While I was working on this, it also became clear the DataFusion summary / intro had diverged so I unified it again

What changes are included in this PR?

Changes:

  1. Clarify that DataFusion is targeted at people building other systems
  2. Ensure that the readme, user guide and library .rs are all in sync

Are these changes tested?

By CI

Are there any user-facing changes?

No functional change, only doc changes

@alamb alamb added the documentation Improvements or additions to documentation label Sep 10, 2024
@github-actions github-actions bot added the core Core DataFusion crate label Sep 10, 2024
Apache DataFusion is a very fast, extensible query engine for building high-quality data-centric systems in
[Rust](http://rustlang.org), using the [Apache Arrow](https://arrow.apache.org)
in-memory format. [Python Bindings](https://github.com/apache/datafusion-python) are also available. DataFusion offers SQL and Dataframe APIs, excellent [performance](https://benchmark.clickhouse.com/), built-in support for CSV, Parquet, JSON, and Avro, extensive customization, and a great community.
DataFusion is an extensible query engine written in [Rust] that
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is now the same as in lib.rs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

While it is redundant to have the same content in three places I think it is worthwhile as the three places are the three most common "landing" pages for people with DataFusion:

  1. The main website https://datafusion.apache.org/
  2. The docs.rs page: https://docs.rs/datafusion/latest/datafusion/index.html
  3. The github repo: https://github.com/apache/datafusion/

@@ -17,24 +17,28 @@
#![warn(missing_docs, clippy::needless_borrow)]

//! [DataFusion] is an extensible query engine written in Rust that
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I clarified this text and made it consistent with the other intros

CSV, Parquet, JSON, and Avro, extensive customization, and a great
community.

DataFusion is an extensible query engine written in `Rust <http://rustlang.org>`_ that
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it could be argued that we should move this content out of the github readme.md leave a link to the main website https://datafusion.apache.org/ 🤔

Copy link
Contributor

@phillipleblanc phillipleblanc left a comment

Choose a reason for hiding this comment

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

🚀

Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

lgtm thanks @alamb

@alamb alamb merged commit 97ad0ad into apache:main Sep 12, 2024
26 checks passed
@alamb
Copy link
Contributor Author

alamb commented Sep 12, 2024

Thanks again @phillipleblanc and @comphead for reviewing this. Let's keep iterating on the docs as follow on PRs too.

@alamb alamb deleted the alamb/extensions_and_more_docs branch September 12, 2024 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core DataFusion crate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants