Making Changes

The OODT website is driven using the Jekyll blogging framework. You can find Jekyll installation instructions here.

 

To start the Jekyll hosted website checkout the OODT source code from https://git-wip-us.apache.org/repos/asf/oodt.git and then switch to the site-dev branch. This is the branch that contains all of the website source files and some configuration options that Jenkins understands. In this directory run: 

jekyll serve

Assuming it starts correctly you can then find the OODT website hosted on http://localhost:4000 . Jekyll will rebuild the website for every change you make and stores them in the _site directory, ensure that directory isn't committed to the git repo as its a working directory.

Automatic modules

There are a couple of pieces of the website we build dynamically. Firstly the PMC list on https://oodt.apache.org/community.html should update when you build or serve the webapp, this of course relies on a working internet connection and access to the ASF phonebook.

Secondly the release downloads and latest version is dynamically generated. To add a new release edit _config.yml inside you will find a release section that looks like:

oodt_releases:
 - version: "1.0"
 date: JUN-2016
 pgp_signature: 783CE7BB Tom Barber
...

Add the latest release to the top in the same format and rebuild the site and it should add the latest details to the download page.

Building the OODT site docs

You will need to:

  1. git checkout master
  2. mvn site:stage
  3. Copy the contents of target/staging/ to the asf-site branch in Apache OODT github

Publishing the changes

To publish the changes first we need to build the website:

jekyll build

This will put the site into the _site directory. Then you need to move all the contents of the _site directory into the asf-site branch in the git repository. Currently its easiest just to copy the files elsewhere then checkout asf-site and move all the files back into the git working tree. Once this is done git add all, commit and push it back to the ASF git repository. After a few minutes the changes should then be reflected on http://oodt.apache.org

 

  • No labels