datafusion icon indicating copy to clipboard operation
datafusion copied to clipboard
verified publisher icon apache

Epic: Better / Improved Documentation, Tutorials and Examples

Open alamb opened this issue 2 years ago • 2 comments

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

  • [ ] https://github.com/apache/arrow-datafusion/issues/7014
  • [ ] 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
  • [ ] https://github.com/apache/datafusion/issues/11336
  • [ ] https://github.com/apache/datafusion/issues/11388

Rust Docs (docs.rs)

  • [ ] Update SQL functions rustdocs with example usage
  • [ ] 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
  • [ ] Include examples reading from object stores (S3, Azure, GCS)
  • [ ] #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

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
  • [ ] https://github.com/apache/arrow-datafusion/issues/6781

Other

  • [ ] https://github.com/apache/arrow-datafusion/issues/9173
  • [ ] https://github.com/apache/arrow-datafusion/issues/1578
  • [ ] 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

alamb avatar Jul 18 '23 17:07 alamb

@alamb - can you add a "devrel" tag to these issues? That would help me track them. Thanks!

MrPowers avatar Jul 23 '23 13:07 MrPowers

@alamb - can you add a "devrel" tag to these issues? That would help me track them. Thanks!

Done @MrPowers : https://github.com/apache/arrow-datafusion/labels/devrel

alamb avatar Jul 24 '23 18:07 alamb