tree: ad6574aa1a6cb7f7dc78974376cee8a9dcb5d43c [path history] [tgz]
  1. docs/
  2. deploy.sh
  3. mkdocs.yml
  4. README.md
  5. requirements.txt
site/README.md

Apache Iceberg Site

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 page file names: [link text](target-page.md)

Installation

The site is built using mkdocs. To install mkdocs and the theme, run:

pip install -r requirements.txt

Local Changes

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

Publishing

After site changes are committed, you can publish the site to the apache remote with this command:

./gradlew deploySite