apache / datafusion-comet

Apache DataFusion Comet Spark Accelerator
https://datafusion.apache.org/comet
Apache License 2.0
653 stars 119 forks source link

Add more developer documentation #230

Open psvri opened 3 months ago

psvri commented 3 months ago

What is the problem the feature request solves?

I would like to have more documentation around the project. I was planning of creating a sphinx documentation as a starting point since its the same used in datafusion as well (https://github.com/apache/arrow-datafusion/tree/main/docs/source). Later on I would like to expand that to how rapids provides it (https://nvidia.github.io/spark-rapids/developer-overview/) . Let me know your thoughts and if you are okay with me creating a skeleton documentation to start of first ?

Describe the potential solution

No response

Additional context

No response

andygrove commented 2 months ago

I am also interested in contributing to the developer documentation as I get up to speed on this project.

I don't have a strong preference for sphinx or any other format but would be interested to see what others think.

andygrove commented 2 months ago

I went ahead and created https://github.com/apache/datafusion-comet/pull/314 to set up a minimal site, using the same scripts and tools as DataFusion. It would be great to have some PRs to add content to this site.

Here are my thoughts on some good areas to contribute:

viirya commented 2 months ago

I would like to add a section like Installation or something like that after "What is Comet?"

andygrove commented 2 months ago

We should also explain how the shims work for different Spark versions