remove some incubator declaration
1 file changed
tree: b4880fa4e6c20659c4c7fb888ecce26e768f03ce
  1. _includes/
  2. _layouts/
  3. _sass/
  4. css/
  5. data/
  6. fonts/
  7. images/
  8. js/
  9. .gitignore
  10. _config.yml
  11. community.md
  12. conf.md
  13. contribute.md
  14. contributors.md
  15. deploy.sh
  16. download.md
  17. index.html
  18. latest.md
  19. LICENSE
  20. profiling.md
  21. quickstart.md
  22. README.md
  23. usecases.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