Repository: airavata-site Updated Branches: refs/heads/asf-site 0402c689b -> 60809c674
updating instructions Project: http://git-wip-us.apache.org/repos/asf/airavata-site/repo Commit: http://git-wip-us.apache.org/repos/asf/airavata-site/commit/60809c67 Tree: http://git-wip-us.apache.org/repos/asf/airavata-site/tree/60809c67 Diff: http://git-wip-us.apache.org/repos/asf/airavata-site/diff/60809c67 Branch: refs/heads/asf-site Commit: 60809c6740c3d017c9b81b8bd8957ebfb35523d1 Parents: 0402c68 Author: Suresh Marru <[email protected]> Authored: Mon Aug 29 21:06:31 2016 -0400 Committer: Suresh Marru <[email protected]> Committed: Mon Aug 29 21:06:31 2016 -0400 ---------------------------------------------------------------------- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/airavata-site/blob/60809c67/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 1b4f224..5c08fd1 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@ # Apache Airavata website -This is next generation website for [Apache Airavata](http://airavata.apache.org). +This repo contains sources and html for [Apache Airavata](http://airavata.apache.org) website. ### About this site The site's content is written in Mark Down which is built with [Jekyll](http://jekyllrb.com/) to convert to html -The git repo only has one branch asf-site and the parent folder has all mark down files. Jekyll will be used to generate the HTML. The generated files are served from 'content' folder. +The git repo only has one branch asf-site and the *source* folder has all mark down files. Jekyll will be used to generate the HTML. The generated files are served from 'content' folder. It is important to understand this distinction: -1. The parent folder has raw markdown files and jekyll code and includes resources for building including the css, javascript and images. -1. The generated static website content is in the content folder. This is the actual static content hosted but do not edit it directly. -Beam website. +1. The *source* folder has raw markdown files and jekyll code and includes resources for building including the css, javascript and images. +1. The generated static website content is in the content folder. This is the actual static content hosted but *do not edit* it directly. -### Development setup -Before working with the Jekyll code, you will need to install Jekyll: +### One time Development setup +If you do not have Jekyll, you will need to first install it: $ gem install jekyll @@ -25,7 +24,7 @@ For more instructions refer to the documentation on [Jekyll](http://jekyllrb.com ### Live development While you are working with the website, you can test and develop live. Run the -following command in the root folder of the website: +following command in the *source* folder of the website: $ jekyll serve
