Mirror of Apache Griffin Site

Clone this repo:
  1. 8d1816a remove incubator from docs page by William Guo · 2 weeks ago master
  2. c972679 update generated site by force by William Guo · 3 weeks ago
  3. bc7bbb3 update site to 0.6.0 by William Guo · 3 weeks ago
  4. 3fd5892 Revert "Initial commit" by William Guo · 3 weeks ago
  5. d92df3b Revert "Updated asf-site site from master (fe054b6b115af279fd0ddb42c33f6bcde06d11c0)" by William Guo · 3 weeks 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