This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow-site.git
The following commit(s) were added to refs/heads/main by this push:
new f8987987e4 Document the new site build requirements (#1743)
f8987987e4 is described below
commit f8987987e4ec4b630885b85f7e07e5fcc2093548
Author: Jarek Potiuk <[email protected]>
AuthorDate: Sun Nov 15 05:44:35 2026 +0100
Document the new site build requirements (#1743)
The README build steps now list Node 24, Hugo >= 0.170.0 and Dart Sass
(available as `dart-sass`), and link to the CI workflow instead of a
stale line number. CONTRIBUTE.md's macOS section moves to Node 24 and
gets its missing closing code fence, and AGENTS.md points at the
theme's new location inside the Docsy submodule.
Generated-by: Claude Opus 5
---
AGENTS.md | 2 +-
CONTRIBUTE.md | 7 ++++---
README.md | 10 +++++++---
3 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
index 1a35719d7b..2cd42cfde7 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -20,7 +20,7 @@
## Repository Structure
- `landing-pages/` — Hugo-based landing pages (HTML, SCSS, JS)
- - `site/themes/docsy/` — Docsy theme (npm dependencies)
+ - `site/themes/docsy/` — Docsy theme submodule; the theme itself is in
`theme/` (deps: `npm run install:theme-deps`)
- `sphinx_airflow_theme/` — Sphinx theme package for Airflow documentation
- `demo/` — theme demo site
- `.github/workflows/` — CI workflows (build, dependabot)
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index 7b786e2e28..15a16a3c4b 100644
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -162,11 +162,12 @@ To verify your Hugo version meets the requirement (>=
0.170.0), run:
hugo version
```
-To install Node 22, first install the [Node version
manager](https://github.com/nvm-sh/nvm), `nvm`. Then, install Node 22 with
these commands:
+To install Node 24, first install the [Node version
manager](https://github.com/nvm-sh/nvm), `nvm`. Then, install Node 24 with
these commands:
```bash
-nvm install 22
-nvm use 22
+nvm install 24
+nvm use 24
+```
To install Yarn, run the following command:
```bash
diff --git a/README.md b/README.md
index d767ca1596..eef0680221 100644
--- a/README.md
+++ b/README.md
@@ -52,9 +52,13 @@ git submodule update --init --recursive
---
In order to build the site locally,
-1. Install [Node.js and NPM](https://nodejs.org/en/download)
-2. Make sure you have [HUGO](https://gohugo.io/installation/) installed.
You're recommended to install the version that is being used in the [CI
build](https://github.com/apache/airflow-site/blob/main/.github/workflows/build.yml#L53)
job.
-3. Run script `<ROOT DIRECTORY>/site.sh build-site`.
+1. Install [Node.js](https://nodejs.org/en/download) 24 and NPM.
+2. Make sure you have [HUGO](https://gohugo.io/installation/) >= 0.170.0
installed. You're recommended to install the version that is being used in the
[CI build](.github/workflows/build.yml) job (see the "Install Hugo" step).
+3. Install [Dart Sass](https://sass-lang.com/dart-sass/) and make it available
on `PATH` as `dart-sass`
+ (Hugo checks that name before `sass`, so the JavaScript `sass` from
`node_modules/.bin` can't shadow it).
+ On macOS: `brew install sass/sass/sass && ln -s "$(brew --prefix)/bin/sass"
"$(brew --prefix)/bin/dart-sass"`.
+ See [CONTRIBUTE.md](CONTRIBUTE.md) for other platforms.
+4. Run script `<ROOT DIRECTORY>/site.sh build-site`.
In order to preview landing pages, run script `<ROOT DIRECTORY>/site.sh
preview-landing-pages`.