alamb commented on issue #1821: URL: https://github.com/apache/arrow-datafusion/issues/1821#issuecomment-1038987201
In general, I like this idea / organization a lot. Thank you for writing it down @matthewmturner My biggest piece of feedback / request for any reorganization is to ensure we keep the following content clearly delinated: 1. Content for those who want to *use* DataFusion in their project (examples, cookbook, etc) 2. Content for those who want to *develop* DataFusion In particular I think it is very important not to mix the developer documentation with the user documentation That being said, I also think the SQL reference / feature list (being targeted towards users) might be good to feature in a more prominent section (alongside Rust) > I personally really like having Cookbooks to learn the idiomatic / performant ways to perform various tasks (see https://arrow.apache.org/cookbook/py/ as an example). That being said I recognize it would be extra work and likely isnt needed in the short run until the core structure is in place. But in the medium to longer term I think there is real value in it - in particular for new users. I agree -- one thing I think we could do is to make the existing "examples" more discoverable (you basically now have to check out the code and know where to look): https://github.com/apache/arrow-datafusion/tree/master/datafusion-examples/examples . There are a lot of good examples there. > Similar can be said for the Internals section in rust. That being said, I believe @alamb and @andygrove have already produced some presentations / talks that could potentially be leveraged to help fill in those details (on top of whatever is in docs.rs). 👍 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
