This directory contains the sources/templates for generating the Apache Calcite website, calcite.apache.org. The actual generated content of the website is present in the calcite-site repository.

1. Install docker
2. Install docker compose

1. cd site
2. docker compose run build-site

1. cd site
2. docker compose run generate-javadoc

You can preview your work while working on the site.

1. cd site
2. docker compose run --service-ports dev

The web server will be started on http://localhost:4000

As you make changes to the site, the site will automatically rebuild.

We want to deploy project changes (for example, new committers, PMC members or upcoming talks) immediately, but we want to deploy documentation of project features only when that feature appears in a release.

Calcite publishes the website automatically since CALCITE-3129, you do not need to do anything but just merge your changes to the main branch, Github workflows will identify changes to website and automatically cherry-pick it to the site branch, compile and publish it to calcite-site repo.

We'll publish the website changes such as community member changes and new blogs immediately after merging. The rules and scripts are in .github/workflows/publish-non-release-website-updates.yml.

We identify release publishing by checking new release tags. If you are the Release Manager, you only need to push the new tag 'calcite-x.y.z' to Calcite Github repo, and the Github workflow will do all the rest. The rules and scripts are in .github/workflows/publish-website-on-release.yml.