alamb commented on code in PR #5962:
URL: https://github.com/apache/arrow-datafusion/pull/5962#discussion_r1164578596


##########
docs/source/contributor-guide/architecture.md:
##########
@@ -20,7 +20,8 @@
 # Architecture
 
 DataFusion's code structure and organization is described in the
-[Crate Documentation], to keep it as close to the source as
-possible.
+[crates.io documentation], to keep it as close to the source as
+possible. You can find the most up to date version in the [source code].

Review Comment:
   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



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