Add Elena's GSOD impressions (#225)

1 file changed
tree: 344fc666e1510a54d9b801db2c0cc4f41f8a3c0f
  1. .asf.yaml
  2. .dockerignore
  3. .editorconfig
  4. .gitignore
  5. .gitmodules
  6. .hadolint.yaml
  7. .pre-commit-config.yaml
  8. .travis.yml
  9. CONTRIBUTE.md
  10. Dockerfile
  11. README.md
  12. docs-archive/
  13. landing-pages/
  14. license-templates/
  15. requirements.txt
  16. site.sh
  17. sphinx_airflow_theme/
README.md

Apache Airflow website

Build Status

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. Hence, to clone the repository correctly, run the following command:

git clone --recurse-submodules git@github.com:apache/airflow-site.git

or

git clone --recurse-submodules https://github.com/apache/airflow-site.git


In order to build site, 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.