You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2023/03/07 14:50:28 UTC

[GitHub] [arrow-datafusion] alamb opened a new issue, #5501: Create a Developers / Hackers guide for DataFusion

alamb opened a new issue, #5501:
URL: https://github.com/apache/arrow-datafusion/issues/5501

   **Is your feature request related to a problem or challenge? Please describe what you are trying to do.**
   DataFusion is primarily aimed at developers, as explained in https://github.com/apache/arrow-datafusion#use-cases
   
   Thus, it will help if provide documentation that helps developers understand what DataFusion offers and if it is appropriate for their project or not. 
   
   
   **Describe the solution you'd like**
   I would like a DataFusion Architecture guide – aimed at other developers, that contains high level information about how DataFusion is organized (for example, with the content described in #5499)
   
   The trick will be to keep the guide helpful but general enough that it doesn't get out of date too quickly
   
   Topics:
   * Basic flow
   * Important structures (LogicalPlan, Exprs, SessionContext, PhysicalExpr, ExecutionPlan)
   * DataSources (TableProvider trait, etc)
   
   
   
   
   
   **Describe alternatives you've considered**
   <!--
   A clear and concise description of any alternative solutions or features you've considered.
   -->
   
   **Additional context**
   Part of a larger effort to improve documentation https://github.com/apache/arrow-datafusion/issues/3058
   


-- 
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: github-unsubscribe@arrow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-datafusion] alamb commented on issue #5501: Create a Developers / Hackers guide for DataFusion

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #5501:
URL: https://github.com/apache/arrow-datafusion/issues/5501#issuecomment-1496615598

   One thing I have been thinking about is where to put this information
   
   So far I have found at least two possiblities:
   https://arrow.apache.org/datafusion/contributor-guide/architecture.html
   https://docs.rs/datafusion/latest/datafusion/index.html#parse-plan-optimize-execute
   
   In general I think keeping the architecture / code documentation as close to the code as possible is a good idea, so I am leaning towards keeping in in doc comments 
   


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-datafusion] alamb closed issue #5501: Improve the docs for developers (Create a Developers / Hackers guide for DataFusion)

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb closed issue #5501: Improve the docs for developers (Create a Developers / Hackers guide for DataFusion)
URL: https://github.com/apache/arrow-datafusion/issues/5501


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-datafusion] alamb commented on issue #5501: Create a Developers / Hackers guide for DataFusion

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #5501:
URL: https://github.com/apache/arrow-datafusion/issues/5501#issuecomment-1500883117

   I have begun cleaning up. First PR: https://github.com/apache/arrow-datafusion/pull/5921


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-datafusion] alamb commented on issue #5501: Create a Developers / Hackers guide for DataFusion

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #5501:
URL: https://github.com/apache/arrow-datafusion/issues/5501#issuecomment-1497323555

   I plan to work on this item over the next few weeks


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org