Apache Daffodil Website

Clone this repo:

Branches

  1. 8fe3ef6 Update vscode 1.3.0 page for rc2 by Shane Dell · 14 days ago main
  2. f031aa9 Stage Daffodil VS Code Extension release v1.3.0-rc2 by Shane Dell · 14 days ago
  3. 64fef9b Support release candidate download links by Steve Lawrence · 5 weeks ago
  4. aeef789 Add 1.3.0 release page for vscode extension by Shane Dell · 5 weeks ago
  5. 89a90dc Stage Daffodil VS Code Extension release v1.3.0-rc1 by Shane Dell · 5 weeks ago

Apache Daffodil Website

The Apache Daffodil website is based off of the Apache Website Template.

The website is generated using Jekyll and some plug-ins for it.

Testing Locally

To improve reproducibility and to minimize the effects and variability of a users environment, it is recommended that changes to the site repo be tested locally with a container. To do so, run one of the following commands.

With docker:

docker run -it --rm \
  --publish 127.0.0.1:4000:4000 \
  --volume="$PWD:/srv/jekyll" \
  docker.io/jekyll/jekyll:4.2.0 \
  jekyll serve --watch --source site

With rootless podman:

podman run -it --rm \
  --publish 127.0.0.1:4000:4000 \
  --volume="$PWD:/srv/jekyll" \
  --env JEKYLL_ROOTLESS=1 \
  docker.io/jekyll/jekyll:4.2.0 \
  jekyll serve --watch --source site

Then open http://localhost:4000 to view the site served by the Jekyll container. Changes to files in the site directory are automatically rebuilt and served.

Once satisfied, create a branch and open a pull request using the Daffodil project Code Conttributor Workflow but using the website repo instead of the code repo.

Publishing to the Live Site

Daffodil uses gitpubsub for publishing to the website. The static content served via Apache must be served in the content directory on the asf-site orphan branch. When changes are merged into the main branch on GitHub, a GitHub action will automatically run and perform the necessary steps to publish the site.