Initial commit
11 files changed
tree: 7168c6e927008597dd84538cfbe9377f7f21a66d
  1. .idea/
  2. .sass-cache/
  3. _includes/
  4. _layouts/
  5. _sass/
  6. _site/
  7. css/
  8. fonts/
  9. images/
  10. js/
  11. .DS_Store
  12. .gitignore
  13. _config.yml
  14. community.md
  15. conf.md
  16. deploy.sh
  17. download.md
  18. index.html
  19. latest.md
  20. LICENSE
  21. quick-start.md
  22. README.md
  23. usecases.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