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

Apache Calcite docs site

This directory contains the code for the Apache Calcite web site, calcite.apache.org.

Setup

Note that the site can currently only be built with Ruby 2.1.x.

  1. cd site
  2. svn co https://svn.apache.org/repos/asf/calcite/site target
  3. sudo apt-get install rubygems ruby2.1-dev zlib1g-dev (linux)
  4. sudo gem install bundler github-pages jekyll jekyll-oembed
  5. bundle install

Add javadoc

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

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

Pushing to site

  1. cd site
  2. svn co https://svn.apache.org/repos/asf/calcite/site target
  3. cd target
  4. svn status
  5. You'll need to svn add any new files
  6. svn ci

Within a few minutes, svnpubsub should kick in and you'll be able to see the results at calcite.apache.org.

This process also publishes Avatica‘s web site. Avatica’s web site has separate source (under avatica/site) but configures Jekyll to generate files to site/target/avatica, which becomes an avatica sub-directory when deployed. See Avatica site README.