Repository navigation
Consider using GitHub pages for DataFusion/Ballista documentation #18
Description
Activity
I was toying with the idea of an mdbook-style user guide for DataFusion recently - a unified setup for DF and Ballista would be excellent :)
Reacted by Andy GroveI created a new issue [1] and corresponding PR to create a unified mdbook setup for the user guide for DataFusion and Ballista.
I did this as a separate issue because writing the user guide is a separate concern from how and where we will publish it at release time.
[1] #19
We should also have the ability to publish release notes and general blog posts on GitHub pages.
I started looking into this. I propose that we create a
gh-pagesbranch that will host the website (jekyll-based site with blog). As part of the release process, we can publish the mdbook content here.I've written up a proposal: https://docs.google.com/document/d/1oIb4QJMzFmA0bqaP42YQWgmnPiHqOTYzwmukANV5O-U/edit?usp=sharing
I am closing this based on the feedback in the discussion at https://lists.apache.org/thread.html/r0ed76cc60cdf651e8cf5c82a21cc64114c1f6d174dc5487434bd32ef%40%3Cdev.arrow.apache.org%3E
@andygrove so the new plan is to host the datafusion website under
arrow.apache.org/datafusionright? Are you actively working on this?- Yes, I believe that is the plan now. I am not actively working on it.…On Wed, Jul 28, 2021, 10:33 AM QP Hou ***@***.***> wrote: @andygrove <https://github.com/andygrove> so the new plan is to host the datafusion website under arrow.apache.org/datafusion right? Are you actively working on this? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#18 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHEBRCG4GENPGAYP4B4ZSDT2A5PZANCNFSM43IIEK5Q> .
- added a commit that references this issue
on Jan 14, 2022 - added a commit that references this issue
on Jul 23, 2024 - added a commit that references this issue
on Mar 23, 2025 - added a commit that references this issue
on Apr 6, 2025 - added a commit that references this issue
on May 2, 2025
ASF supports enabling GitHub pages via asf.yaml [1] and we could consider using this to publish end user documentation for DataFusion and Ballista.
Ballista already has a minimal user guide in mdbook format that is part of this repo [2] and is currently published to https://ballistacompute.org/docs/ but it would be better to publish it here as part of the DataFusion user guide?
[1] https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features
[2] https://github.com/apache/arrow-datafusion/tree/master/ballista/docs/user-guide