Apache griffin (Incubating)

Clone this repo:
  1. b5ea7f1 update website by William Guo · 9 months ago master
  2. 6e06ac9 update vip by William Guo · 9 months ago
  3. 9504b7a remove some incubator declaration by William Guo · 9 months ago
  4. 3711d04 update graduate info by William Guo · 9 months ago
  5. 9531faf Fixes to comply with whimsy website checker by Roy Lenferink · 9 months ago

Apache Griffin Documentation Site

Welcome to the Apache Griffin documentation!

Prerequisites

Install jekyll gem

$ gem install jekyll

Generate the site, and start a server locally:

$ jekyll serve -w

The -w option tells jekyll to watch for changes to files and regenerate the site automatically when any content changes.

Point your browser to http://localhost:4000

By default, jekyll will generate the site in a _site directory.

Editing documentations

  1. Create a markdown file and add following content in header

     ---
     layout: doc
     title:  "Griffin Overview" 
     permalink: /docs/some-new-doc.html
     ---
    
     More content here ..
    

Publishing the Apache Website

In order to publish the website, you must have committer access to Apache Griffin's apache repository.

To publish changes, run

bash ./deploy.sh