Google Git
Sign in
apache / airflow-site / 743208832f968a52df008ff2ae7987f2600fc8f2
commit743208832f968a52df008ff2ae7987f2600fc8f2[log] [tgz]
authorJarek Potiuk <jarek@potiuk.com>Tue Nov 11 22:27:36 2025 +0100
committerGitHub <noreply@github.com>Tue Nov 11 22:27:36 2025 +0100
treed115b9f7d0a8a7ffb0f3554a599dcd58c31e70bd
parent1f2a0395d5cc7fa38f0c480bf6ae6bdc5b2a1c8e [diff]
Modernize CI setup for airflow-site (#1272)

* Use prek instead of pre-commit
* add actions for prek, zizmor, octopin to keep the
  actions and prek updated and secure
* Switch to latest dependencies (lock files)
* add Dependabot for npm dependencies
10 files changed
tree: d115b9f7d0a8a7ffb0f3554a599dcd58c31e70bd
  1. .github/
  2. landing-pages/
  3. license-templates/
  4. sphinx_airflow_theme/
  5. .asf.yaml
  6. .dockerignore
  7. .editorconfig
  8. .gitignore
  9. .gitmodules
  10. .hadolint.yaml
  11. .pre-commit-config.yaml
  12. CONTRIBUTE.md
  13. Dockerfile
  14. README.md
  15. site.sh
README.md

Apache Airflow website

Build docs

This is a repository of Apache Airflow website. The repository of Apache Airflow can be found here.

General directory structure

  • docs-archive - directory containing archived documentation versions and shell script generating docs index,
  • landing-pages - directory containing the source code of landing pages,
  • license-templates - directory containing license templates,
  • sphinx_airflow_theme - directory containing source code of sphinx theme for Apache Airflow documentation site.

For more detailed description of directory structure, please refer to contributor's guide.

Getting started

If you're a Macbook user, first install coreutils.

brew install coreutils

The Docsy theme required for the site to work properly is included as a git submodule.

This means that after you already cloned the repository, you need to update submodules

git submodule update --init --recursive

In order to build the site locally,

  1. Install Node.js and NPM
  2. Make sure you have HUGO installed. You're recommended to install the version that is being used in the CI build job.
  3. Run script <ROOT DIRECTORY>/site.sh build-site.

In order to preview landing pages, run script <ROOT DIRECTORY>/site.sh preview-landing-pages.

In order to work with documentation theme, please refer to Sphinx Airflow theme's readme file.

For more detailed description of site.sh capabilities, please refer to contributor's guide.

Contributor's guide

If you'd like to contribute to the Apache Airflow website project, read our contributor's guide where you can find detailed instructions on how to work with the website.