Repository: airavata-site Updated Branches: refs/heads/asf-site 6d785d628 -> 149d05cc6
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/149d05cc Tree: http://git-wip-us.apache.org/repos/asf/airavata-site/tree/149d05cc Diff: http://git-wip-us.apache.org/repos/asf/airavata-site/diff/149d05cc Branch: refs/heads/asf-site Commit: 149d05cc6ed7127d1ac4fbb12c5caf3e2b2dbce0 Parents: 6d785d6 Author: Suresh Marru <[email protected]> Authored: Thu Apr 7 13:12:07 2016 -0400 Committer: Suresh Marru <[email protected]> Committed: Thu Apr 7 13:12:07 2016 -0400 ---------------------------------------------------------------------- README.md | 67 ++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 44 insertions(+), 23 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/airavata-site/blob/149d05cc/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 0f2cb68..c2ab191 100644 --- a/README.md +++ b/README.md @@ -3,26 +3,47 @@ This is next generation website for [Apache Airavata](http://airavata.apache.org). ### About this site -Initial version of the site will be plain HTML and will eventually be replaced by a [Jekyll](http://jekyllrb.com/) based site. - -The git repo will only have one branch asf-site and the parent folder will have mark down files. Jekyll will be used to generate the HTML. The generated files will be served from 'content' folder. - -Currently only the 'content' folder will be populated. - -# ${Airavata Website Redesign} -TODO: Write a project description -## Installation -TODO: Describe the installation process -## Usage -TODO: Write usage instructions -## Contributing -1. Fork it! -2. Create your feature branch: `git checkout -b my-new-feature` -3. Commit your changes: `git commit -am 'Add some feature'` -4. Push to the branch: `git push origin my-new-feature` -## History -TODO: Write history -## Credits -TODO: Write credits -## License -TODO: Write license \ No newline at end of file +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. + +It is important to understand this distinguishn: + +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. + +### Development setup +Before working with the Jekyll code, you will need to install Jekyll: + + $ gem install jekyll + +*If you are on a Mac, you may need to install +[Ruby Gems](https://rubygems.org/pages/download).* + +For more instructions refer to the documentation on [Jekyll](http://jekyllrb.com/) website. + +### 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: + + $ jekyll serve + +Jekyll will start a webserver on port `4000`. As you make changes to the +content, Jekyll will rebuild it automatically. This is helpful if you want to see +how your changes will render in realtime. + +### Generating the static website +Once you are done with your changes, you need to compile the static +content for the website. This is what is actually hosted +on the Apache Beam website. + +You can build the static content by running the following command in the root +website directory: + + $ jekyll build + +Once built, it will be placed in the folder `content` inside of the root directory. +This directory will include images, HTML, CSS, and so on. In a typical Jekyll install +this content would live in `_site` - it has been changed for the Apache Airavata website +to work with the ASF web publishing system.
