Skip to end of metadata
Go to start of metadata

Background

How to Set up Environment

  • Use Ruby and Gem (https://rubygems.org/) to install Jekyll 

    Tips: during installation, error "Could not find a valid gem 'jekyll' (>= 0)..." encountered. To solve it, execute "gem sources --add https://ruby.taobao.org/ --remove https://rubygems.org/" before running "gem install jekyll".


  • Clone Eagle Document Site

  • Build and Preview Eagle Document Site (url is http://127.0.0.1:4000/ by default)

How to Write Document

Before writing documents, please make sure jekyll server running

How to Publish

The main purpose of this step is to build with "jekyll build" and commit changes in "_site" into "http://svn.apache.org/viewvc/incubator/eagle/site/", then http://eagle.incubator.apache.org/ will automatically serve the changes.

  • Clone site from apache svn repository http://svn.apache.org/viewvc/incubator/eagle/site/ into local directory EAGLE_SITE_SVN_DIR for example "eagle-site-svn"

  • Build as static web site into '_site' directory and commit changes under ${EAGLE_SITE_SVN_DIR} back to apache svn repository

  • Commit "_site" content into svn repository 

  • Validate whether the website is updated in http://eagle.incubator.apache.org/docs/

 

 

  • No labels

1 Comment

  1. RVM dosen't recommend to run Ruby as root.