[Epic] Better / Improved Documentation, Tutorials and Examples
- Lingua principale
- Rust
- Stelle
- 9.3k
- Fork
- 2.4k
- Merge medio
- 3g 11h
- PR unite (30g)
- 360
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia esaminando gli elementi non selezionati nelle sezioni User Guide, Rust Docs, Examples e Other, inclusi i relativi issue collegati. Confronta la documentazione e gli esempi attuali con queste attività aperte; il lavoro è completato quando gli elementi rimanenti della checklist sono stati completati o definiti chiaramente in issue separati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- rust
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100