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

[EPIC] Redesign DataFusion main page #14389

Open
comphead opened this issue Jan 31, 2025 · 5 comments
Open

[EPIC] Redesign DataFusion main page #14389

comphead opened this issue Jan 31, 2025 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@comphead
Copy link
Contributor

comphead commented Jan 31, 2025

Is your feature request related to a problem or challenge?

Users currently fell a little bit lost when dealing with Datafusion main page https://github.com/apache/datafusion

Imho the page is overloaded with too technical information, navigations to examples, quick start are not very intuitive.

Describe the solution you'd like

Would be nice to redesign the main page and let it be the face of Datafusion. It should contain intuitive steps to get familiar with Datafusion, quick start, contribution, diagram in short what exactly makes DataFusion a DataFusion, supported features.

For the naive design we can refer to https://github.com/StarRocks/starrocks which is way more user friendly

Describe alternatives you've considered

No response

Additional context

No response

@comphead comphead added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jan 31, 2025
@comphead comphead changed the title [EPIC] Redesign Datafusion main page [EPIC] Redesign DataFusion main page Jan 31, 2025
@comphead
Copy link
Contributor Author

Query Engine

GitHub License
Build Status
GitHub Issues
GitHub Stars

🚀 Introduction

Query Engine is a powerful and efficient engine for querying structured and unstructured data. It provides a fast and flexible way to analyze data across multiple sources.

✨ Features

  • 🔍 Fast Query Execution – Optimized for speed and efficiency.
  • 📡 Multi-Source Support – Works with databases, APIs, and file storage.
  • Flexible Query Language – SQL-like syntax with additional capabilities.
  • 🚀 Scalable – Works on small and large datasets seamlessly.

📌 Use Cases

Data Analytics – Run complex queries on large datasets.
ETL Pipelines – Extract, transform, and load data efficiently.
Log Analysis – Parse logs for insights in real time.

🏗️ Quickstart Guide

Install Query Engine via pip:

pip install query-engine  

Run the help command to get started:

query-engine --help  

💡 Example Queries

SQL Query:

SELECT name, age FROM users WHERE age > 25 ORDER BY age DESC;

Python Usage:

from query_engine import QueryEngine

engine = QueryEngine(data_source="database_url")
results = engine.run("SELECT * FROM logs WHERE error = 'critical'")

🔧 Installation & Setup

For a local setup, clone the repository and install dependencies:

git clone https://github.com/your-repo/query-engine.git
cd query-engine
pip install -r requirements.txt

🤝 Contributing

We welcome contributions! To get started:

  • Open issues for bugs and features.
  • Follow the contribution guide (CONTRIBUTING.md).
  • Use the dev branch for feature work.

🛣️ Roadmap

  • Support for NoSQL databases
  • Web UI for query visualization
  • Performance benchmarking tools

📢 Community & Support

  • Join our Discord/Slack community.
  • Report issues via GitHub Issues.
  • Follow updates on Twitter/GitHub Discussions.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙌 Acknowledgments

Special thanks to all contributors and the open-source community for making this project possible.

@comphead
Copy link
Contributor Author

comphead commented Jan 31, 2025

The structure above is just an example how to make the main page more user friendly

@alamb
Copy link
Contributor

alamb commented Jan 31, 2025

I think it already looks a lot better.

@andygrove or @ozankabak perhaps you have some other ideas

@edmondop
Copy link
Contributor

I also was very confused to find the Rust Version Compatibility Policy in the README.md

@alamb
Copy link
Contributor

alamb commented Feb 1, 2025

I also was very confused to find the Rust Version Compatibility Policy in the README.md

As long as this thing exists somewhere (maybe the contributor guide) this makes sense to me)

I think it would be useful / valuable to think about keeping the readme and the main site in sync

We could go so far as to remove everything from the README.md except for a link to https://datafusion.apache.org/ 🤔

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 enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants