Fix broken navigation script
1 file changed
tree: aa6a0c30d7b3887e4ffeb8e6e5fda2c130d00a67
  1. .sass-cache/
  2. css/
  3. data/
  4. docs/
  5. fonts/
  6. images/
  7. js/
  8. .asf.yaml
  9. deploy.sh
  10. index.html
  11. LICENSE
  12. README.md
README.md

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