Conslidate benchmark runner documentation
- Dominant language
- Rust
- Stars
- 9.3k
- Forks
- 2.4k
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 344
Description
It would be great to have a single entry point for SQL benchmarks that’s easy to discover and use. A couple of ideas toward that goal:
- Move user-facing documentation to `benchmarks/README.md`, and keep `benchmarks/sql_benchmarks/README.md` focused on internal runner details
- Support a local config file (e.g., `toml`) with env vars as overrides. I feel managing many env vars locally is cumbersome.
_Originally posted by @2010YOUY01 in https://github.com/apache/datafusion/pull/21707#pullrequestreview-4160311473_
Contributor guide
Research direction
Start by comparing benchmarks/README.md with benchmarks/sql_benchmarks/README.md and reading the existing SQL benchmark runner details. Done means user-facing guidance has one discoverable entry point, internal runner details remain separate, and local configuration with environment-variable overrides is documented and supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, sql
- Domain
- documentation, performance
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100