Google Git
Sign in
apache / datafusion / b54e648a7ee82e1ef292ef36df7d49902171b94f / . / docs
tree: 0188349f72d16a4abadefaf2fdec9acb514b1dd6 [path history] [tgz]
  1. logos/
  2. source/
  3. .gitignore
  4. build.sh
  5. make.bat
  6. Makefile
  7. README.md
  8. requirements.txt
docs/README.md

DataFusion Documentation

This folder contains the source content of the User Guide and Contributor Guide. These are both published to https://datafusion.apache.org/ 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://datafusion.apache.org/

When the PR is merged to the main branch of the DataFusion 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/.