tree: 1c62136a88544454b796752932c345df58dde84f [path history] [tgz]
  1. .gitignore
  2. Gemfile
  3. README.md
  4. _config.yml
  5. _data/
  6. _docs/
  7. _includes/
  8. _layouts/
  9. _plugins/
  10. _posts/
  11. _sass/
  12. add-avatica-go-docs.sh
  13. community/
  14. css/
  15. develop/
  16. doap_calcite-avatica.rdf
  17. docker-compose.yml
  18. downloads/
  19. favicon.ico
  20. fonts/
  21. img/
  22. index.html
  23. js/
  24. news/
site/README.md

Apache Calcite Avatica site

This directory contains the code for the Avatica web site, a sub-directory of the Apache Calcite web site.

You can build the site manually using your environment or use the docker compose file.

Manually

Setup your environment

Similar to the instructions to set up the Calcite web site.

Site generation currently works best with ruby-2.5.1.

  1. cd site
  2. svn co https://svn.apache.org/repos/asf/calcite/site/avatica target/avatica
  3. sudo apt-get install rubygems ruby2.5-dev zlib1g-dev (linux)
  4. sudo gem install bundler
  5. Add avatica-go content: ./add-avatica-go-docs.sh
  6. bundle install

Add javadoc

  1. cd avatica
  2. ./mvnw -DskipTests site
  3. rm -rf site/target/avatica/apidocs site/target/avatica/testapidocs
  4. mv target/site/apidocs target/site/testapidocs site/target/avatica

Running locally

Before opening a pull request, you can preview your contributions by running from within the directory:

  1. bundle exec jekyll serve
  2. Open http://localhost:4000/avatica/ (note the trailing slash)

Using docker

Setup your environment

  1. Install docker
  2. Install docker-compose

Build site

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

Generate javadoc

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

Running development mode locally

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/avatica/ (note the trailing slash)

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

Pushing to site

Push the Calcite site, which includes avatica as a sub-directory, as described in its README.