This folder contains the source content for the Apache DataFusion Comet documentation site. This content is published to https://datafusion.apache.org/comet when any changes are merged into the main branch.

It's recommended to install build dependencies and build the documentation inside a Python virtualenv.

• Python
• pip install -r requirements.txt

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

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.

This documentation is hosted at https://datafusion.apache.org/comet/

When the PR is merged to the main branch of the datafusion-comet repository, a GitHub workflow which:

1. Builds the html content
2. Pushes the html content to the asf-site branch in this repository.

The Apache Software Foundation provides https://datafusion.apache.org/, which serves content based on the configuration in .asf.yaml, which specifies the target as https://datafusion.apache.org/comet/.