Apache griffin (Incubating)

Clone this repo:
  1. 2ce1ba2 add test cases to faq by William Guo · 8 weeks ago master
  2. 46f1a0c init faq by William Guo · 3 months ago
  3. b507f54 Replace images/project.jpg by dapeng · 9 months ago
  4. f7ecd60 Merge pull request #1 from apache/master by 大鹏 · 9 months ago
  5. 3f07e1d fix image path by William Guo · 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