This directory contains the source for the Iceberg site.
- Site structure is maintained in mkdocs.yml
- Pages are maintained in markdown in the
docs/folder - Links use bare page names:
[link text](target-page)
The site is built using mkdocs. To install mkdocs and the theme, run:
pip install -r requirements.txt
To see changes locally before committing, use mkdocs to run a local server from this directory.
mkdocs serve
To see changes in Javadoc, run:
./gradlew refreshJavadoc
After site changes are committed, you can publish the site with this command:
mkdocs gh-deploy
This assumes that the Apache remote is named apache and will push to the asf-site branch. To use a different remote add -r <remote-name>.