commit | 5412fb493d9fa1c0f96e6e948f4561d14f7baf53 | [log] [tgz] |
---|---|---|
author | Jarek Potiuk <jarek@potiuk.com> | Mon Jul 18 12:13:19 2022 +0200 |
committer | GitHub <noreply@github.com> | Mon Jul 18 12:13:19 2022 +0200 |
tree | a04e3587b0761d7573e0a3752a37c2fc0de0767a | |
parent | 95e01a0eb4da8c54299e0e8a95043f1ba181a325 [diff] |
Change protection rules for airflow-site repository (#639) We pretty much never are able to review airflow-sites changes anyway and we do not need to protect the branch as we do not release software from it - just produce documentation. The protection rules are now: * you cannot push directly to `main` * you need a PR with successful checks * the PR must be up-to-date (i.e. based on latest main) * no need for approval from other committers
This is a repository of Apache Airflow website. The repository of Apache Airflow can be found here.
For more detailed description of directory structure, please refer to contributor's guide.
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 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.
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.