rowdydata.github.io

A repository for materials and experiences in IATI support programmes for NGOs.

Planning and issue tracking

You can have a look at our issue list at Github, or at our Waffle board

Our recent throughput -- remember: we just started :-)

Pull requests are welcome!

Tooling

Jekyll and Liquid

The bulk of the repository is written to be processed by Jekyll, the static site generator offered by Github Pages, using the Liquid template engine.

The short version to get it up and running:

Make sure you have Ruby version 2.0.0 or newer installed: ruby --version
Make sure you have Bundler, or run gem install bundler (maybe with sudo)
Let Bundler do its work: bundle install

Now you can run jekyll build to create a local copy of the website in the folder _site.

If you run jekyll serve, it will continue to watch for changes and update your local copy accordingly. You'll be able to test your local copy by going to the address http://0.0.0.0:4000

Caveat: if you change something in _config.yml you will need to stop and restart Jekyll to read in those changes.

See Github's full instructions on getting a local version up and running

generate-assets

Some things are not processed by the Jekyll engine at Github Pages, so we have a script to take care of some of the additional processing.

Simply call ./generate-assets in a suitable terminal window on a unix-style machine. Then call jekyll build to copy the new assets into your local version of the website.

Some additional tools are needed to be able to do all of this.

(This is an area to improve in the future.)

Ditaa

Ditaa translates ASCII art diagrams into proper images.

The asciiflow online tool makes it easy to create and edit such diagrams.

On Debian-based machines like Ubuntu, you can install Ditaa with sudo apt-get install ditaa