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

   ### Is your feature request related to a problem or challenge?
   
   As part of consolidating our documentation and making it better we have been 
getting the lower level technical documentation about DataFusion into the 
rustdocs as explained here:
   
   
https://arrow.apache.org/datafusion/contributor-guide/architecture.html#architecture
   
   This is good in that keeps the docs close to the code, but it is non ideal 
in that the docs on crates.io  
https://docs.rs/datafusion/latest/datafusion/index.html will only reflect 
released versions and thus will lag behind the latest docs on github
   
   ### Describe the solution you'd like
   
   I think it is a great idea -- thank you @waynexia 
   
   I actually think if we could build those API docs as part of the 
https://github.com/apache/arrow-datafusion/blob/main/docs build, they would 
"automatically" get hosted on https://arrow.apache.org/datafusion/
   
   https://arrow.apache.org/datafusion/ is published via some ASF mechanism 
that is similar to github pages
   
   Specifically, this workflow
   
   
https://github.com/apache/arrow-datafusion/blob/388f9ec3e7f7c09dac56ee0fe074ca97a6af9d44/.github/workflows/docs.yaml#L12-L64
   
   pushes to the https://github.com/apache/arrow-datafusion/tree/asf-site 
branch which then gets hosted via this magic yaml: 
   
   
https://github.com/apache/arrow-datafusion/blob/388f9ec3e7f7c09dac56ee0fe074ca97a6af9d44/.asf.yaml#L48-L52
   
   ### Describe alternatives you've considered
   
   _No response_
   
   ### Additional context
   
   Suggested by @waynexia  
https://github.com/apache/arrow-datafusion/pull/5962#discussion_r1163748404
   


-- 
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]

Reply via email to