Updated asf-site site from master (6bce09ad26984592ee71098a260f51e339a9e48e)
74 files changed
tree: a5ba31aaf343018bc603ee1606c6bcd1862272f3
  1. .idea/
  2. .sass-cache/
  3. css/
  4. docs/
  5. fonts/
  6. images/
  7. js/
  8. .DS_Store
  9. .gitignore
  10. deploy.sh
  11. index.html
  12. LICENSE
  13. README.md
README.md

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 Griffin's apache repository.

To publish changes, run

bash ./deploy.sh