Mirror of Apache Airavata Web Site
HTML JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
content
source
.gitignore
LICENSE
NOTICE
README.md
test3.xml
test4.xml

README.md

Apache Airavata website

This repo contains sources and html for Apache Airavata website.

About this site

The site's content is written in Mark Down which is built with Jekyll to convert to html

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 source folder has raw markdown files and jekyll code and includes resources for building including the css, javascript and images.
  2. The generated static website content is in the content folder. This is the actual static content hosted but do not edit it directly.

One time Development setup

If you do not have Jekyll, you will need to first install it:

$ gem install jekyll

If you are on a Mac, you may need to install Ruby Gems.

For more instructions refer to the documentation on Jekyll website.

Release updates

Update sources/_data/releases.yml file on releases

Live development

While you are working with the website, you can test and develop live. Run the following command in the source 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.