Open Data Handbook v2
CSS HTML Python JavaScript
Latest commit 8341caa Dec 4, 2016 @morchickit morchickit committed on GitHub Merge pull request #277 from Vanuan/patch-1
Add Open Data Charter to resources
Permalink
Failed to load latest commit information.
_data
_includes replace ampersand in filters Aug 15, 2016
_layouts new OK Panel markup May 20, 2016
_sass
contribute Replace single curly quotes to plain ones Aug 19, 2015
credits OKI logos May 10, 2016
css remake changes lost in conflict Aug 17, 2016
glossary Update index.md Jun 26, 2016
guide Fix Indonesian translation and layout Oct 30, 2016
img add solutions banner Aug 16, 2016
js
resources Add Open Data Charter to resources Dec 3, 2016
scripts List the languages in an alphabetical order to be impartial Aug 12, 2015
solutions/en force rebuild Aug 17, 2016
value-stories/en Update index.md Nov 2, 2016
.gitignore removing ds store Jul 13, 2016
404.html rough prototype Feb 9, 2015
CNAME reused CNAME Jul 1, 2015
README.md and theme to list of branches Jun 11, 2015
_config.yml updated toc to show events page Jul 13, 2016
apple-touch-icon.png
favicon.ico
feed.xml jekyll Feb 4, 2015
index.html Replace single curly quotes to plain ones Aug 19, 2015
tile-wide.png icons Feb 24, 2015
tile.png icons Feb 24, 2015

README.md

opendatahandbook-v2

Repository of http://opendatahandbook.org/

This is a Jekyll based site, with pages written in HTML and Markdown (specifically Kramdown), with Markdown being used where possible for ease of editing.

Editors

Please see the Contribute section of the site for further instructions.

Developers

Dependancies

Information architecture

There are four sections of content, implemented as simple Jekyll pages: guide, value-stories, glossary, and resources.

Some sections have translations. These are implemented by adjacent directories, where the name of the directory is the locale of the translation.

Guide

The narrative content of the Open Data Handbook.

Value Stories

A collection of stories demonstrating examples of open data wins.

Glossary

A glossary explaining terms used in the Open Data Handbook.

Resources

Additional resources for the Open Data Handbook.

Working with the glossary

Each glossary (meaning, each glossary translation), is made of three components:

  • A 'glossary.html' layout template
  • A 'glossary/{lang}/index.md' page, which uses the glossary layout to render a list of glossary terms in the correct language
  • A 'glossary/{lang}/terms/' directory, which contains an entry for each glossary term. Each entry is the slugified name of the English version of the term.

Currently, the English glossary has been organized. To expand this pattern to other languages:

  • Copy the English terms directory into your target language directory
  • If your current index.md has translated glossary terms, then add them to the appropriate page under 'terms', replacing the English text that was copied over from 'en'.
  • Then, replace your target language's index.md file with the 'en' one, changing the lang value to that of your target language.

Branches

  • gh-pages - live site
  • master - minimal content, to speed up building (for development)
  • theme - no site specific content, used to create new sites