[Epic] Better / Improved Documentation, Tutorials and Examples
- Dominant language
- Rust
- Stars
- 9.3k
- Forks
- 2.4k
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 344
Description
This is a follow on to https://github.com/apache/arrow-datafusion/issues/3058 as we have made significant progress since @kmitchener originally posted that
“Write cool software and _tell people about it_” – Paul Dix @pauldix (Founder and CTO of InfluxData)
# Call to action:
The DataFusion community has invested a lot in the cool software; This ticket tracks tasks to improve the "tell people about it"
# User Guide
- [x] https://github.com/apache/arrow-datafusion/issues/7014
- [x] https://github.com/apache/arrow-datafusion/issues/3092
- [ ] https://github.com/apache/arrow-datafusion/issues/7015
- [x] https://github.com/apache/arrow-datafusion/issues/7153
- [ ] https://github.com/apache/arrow-datafusion/issues/9016
- [x] https://github.com/apache/arrow-datafusion/issues/7297
- [x] https://github.com/apache/arrow-datafusion/issues/7319
- [x] https://github.com/apache/datafusion/issues/14557
- [x] https://github.com/apache/datafusion/issues/11336
- [ ] https://github.com/apache/datafusion/issues/11388
- [x] https://github.com/apache/datafusion/issues/14435
- [ ] https://github.com/apache/datafusion/issues/24569
# Rust Docs (docs.rs)
- [ ] Update SQL functions rustdocs with example usage
- [x] https://github.com/apache/arrow-datafusion/issues/3092
- [ ] https://github.com/apache/arrow-datafusion/issues/5981
# Examples
- [ ] Review current examples and see how they can be improved
- [x] Include examples reading from object stores (S3, Azure, GCS)
- [x] #6518
- [x] https://github.com/apache/datafusion/issues/11079
- [ ] https://github.com/apache/arrow-datafusion/issues/9561
- [x] https://github.com/apache/datafusion/issues/10855
- [x] https://github.com/apache/datafusion/issues/10871
- [x] https://github.com/apache/datafusion/issues/11172
- [x] https://github.com/apache/datafusion/issues/13714
# Conference Papers
- [x] https://github.com/apache/arrow-datafusion/issues/6782
# Blog posts
- [x] https://github.com/apache/arrow-datafusion/issues/6988
- [x] https://github.com/apache/arrow-datafusion/issues/6780
- [x] https://github.com/apache/arrow-datafusion/issues/6781
# Other
- [x] https://github.com/apache/arrow-datafusion/issues/9173
- [ ] https://github.com/apache/arrow-datafusion/issues/1578
- [x] https://github.com/apache/arrow-datafusion/issues/825
- [x] https://github.com/apache/arrow-datafusion/issues/1927
- [x] https://github.com/apache/datafusion/issues/12088
Contributor guide
Research direction
Start by reviewing the unchecked items in the User Guide, Rust Docs, Examples, and Other sections, including their linked issues. Compare the current documentation and examples with those open tasks; done means the remaining checklist items have been completed or clearly scoped into separate issues.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100