You can build the site manually using your environment or use the docker compose file.
Similar to the instructions to set up the Calcite web site.
Site generation currently works best with ruby-2.5.1.
git clone https://gitbox.apache.org/repos/asf/calcite-site.git target. The site will be generated to target/avatica, so it will be ready for commit.
sudo apt-get install rubygems ruby2.5-dev zlib1g-dev(linux)
sudo gem install bundler
./gradlew javadocAggregate # the result is placed to build/docs/javadocAggregate
Before opening a pull request, you can preview your contributions by running from within the directory:
bundle exec jekyll serve
bundle exec jekyll build
docker-compose run build-site
docker-compose run generate-javadoc
You can preview your work while working on the site.
docker-compose run --service-ports dev
The web server will be started on http://localhost:4000/avatica/ (note the trailing slash)
As you make changes to the site, the site will automatically rebuild.
Push the Calcite site, which includes
avatica as a sub-directory, as described in its README.