Airflow Site screenshot

Airflow Site

Author Avatar Theme by Apache
Updated: 19 May 2025
144 Stars

Apache Airflow Website

Overview:

The Apache Airflow website is a repository containing the source code for the Apache Airflow documentation site. It includes archived documentation versions, landing pages, license templates, and a Sphinx theme for the documentation. The website provides a comprehensive guide for users and contributors to understand and work with Apache Airflow.

Features:

  • Archived documentation versions: The repository includes a directory containing archived versions of the documentation.
  • Landing pages: The source code for landing pages is available in a separate directory, allowing for easy customization and updates.
  • License templates: A directory with license templates is provided, ensuring proper licensing for the documentation site.
  • Sphinx Airflow theme: The repository includes a directory containing the source code of the Sphinx theme specifically designed for the Apache Airflow documentation site.

Installation:

To build and work with the Apache Airflow website locally, follow these steps:

  1. If you are a Macbook user, install coreutils by running the following command:

    brew install coreutils
    
  2. Clone the repository to your local machine.

  3. Update the git submodules by running the following command:

    git submodule update --init --recursive
    
  4. Install Node.js and NPM.

  5. Ensure that you have HUGO installed, preferably the version being used in the CI build job.

  6. To build the site locally, run the following script from the root directory of the repository:

    <ROOT DIRECTORY>/site.sh build-site
    
  7. To preview landing pages, run the following script:

    <ROOT DIRECTORY>/site.sh preview-landing-pages
    
  8. If you want to work with the documentation theme, refer to the readme file of the Sphinx Airflow theme for instructions.

For more detailed information on the capabilities of the site.sh script, please consult the contributor’s guide.

Summary:

The Apache Airflow website repository contains all the necessary components for building and customizing the documentation site. It provides features such as archived documentation versions, customizable landing pages, license templates, and a specific Sphinx theme. By following the installation guide and referring to the contributor’s guide, users can easily contribute to and modify the Apache Airflow website.