Andrew Lamb
85afd4bd7f
* Update DataFusion architecture documentation * Apply suggestions from code review Co-authored-by: comphead <comphead@users.noreply.github.com> Co-authored-by: Yang Jiang <jiangyang381@163.com> --------- Co-authored-by: comphead <comphead@users.noreply.github.com> Co-authored-by: Yang Jiang <jiangyang381@163.com>
DataFusion Documentation
This folder contains the source content of the User Guide and Contributor Guide. These are both published to https://arrow.apache.org/datafusion/ as part of the release process.
Dependencies
It's recommended to install build dependencies and build the documentation inside a Python virtualenv.
- Python
pip install -r requirements.txt
Build & Preview
Run the provided script to build the HTML pages.
./build.sh
The HTML will be generated into a build directory.
Preview the site on Linux by running this command.
firefox build/html/index.html
Making Changes
To make changes to the docs, simply make a Pull Request with your proposed changes as normal. When the PR is merged the docs will be automatically updated.
Release Process
This documentation is hosted at https://arrow.apache.org/datafusion/
When the PR is merged to the main branch of the DataFusion
repository, a github workflow which:
- Builds the html content
- Pushes the html content to the
asf-sitebranch in this repository.
The Apache Software Foundation provides https://arrow.apache.org/, which serves content based on the configuration in .asf.yaml, which specifies the target as https://arrow.apache.org/datafusion/.