Google GitGoogle Git
Sign in
apache/incubator-toree-website

Mirror of Apache Toree website (Incubating)

Mirrored from https://github.com/apache/incubator-toree-website.git
Clone this repo:

Branches

  1. c04342c Update NOTICE by PJ Fanning · 2 weeks ago master
  2. 260b73a Update copyright year in footer.html by PJ Fanning · 3 weeks ago
  3. 700ad79 Fix typo on website name by Luciano Resende · 12 months ago
  4. 637cbea Update pip install command for Apache Toree (#15) by PJ Fanning · 12 months ago
  5. 4183d0e Fix typo in project description (#14) by PJ Fanning · 12 months ago

Apache Toree Website

This project is used to generate the Apache Toree website and is based on the Apache Website Template

This template was generated using Jekyll 2.4.0.

To use it, copy the site directory into your project. You must also include licensing information from the LICENSE and NOTICE files in your own project.

How to deploy your project's web site

Setup

1. cd site
2. svn co https://svn.apache.org/repos/asf/incubator/toree/site target
3. Jekyll requires ruby, more details on https://jekyllrb.com/docs/installation
4. gem install --user-install bundler github-pages jekyll
5. add local .gem directory to path
5.1 echo 'export PATH="$HOME/.gem/ruby/X.X.0/bin:$PATH"' >> ~/.bash_profile
6. bundle install

Add javadoc

If your project supports javadoc, you can copy the generated javadoc into svn each time you need to re-generate.

1. cd ..
2. mvn -DskipTests site
3. mv target/site/apidocs 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 --watch
2. Open [http://localhost:4000](http://localhost:4000)

Pushing to site

1. cd site/target
2. svn status
3. You'll need to `svn add` any new files
4. svn ci

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

Adding contributors

To add a contributor to the project, or to modify existing contributors, edit site/_data/contributors.yml. The [project members]([http://localhost:4000/community.html#project-members] list will re-generate.