https://github.com/okfn/opendatahandbook

Open Data Handbook v2
https://github.com/okfn/opendatahandbook

Last synced: about 1 month ago
JSON representation

Open Data Handbook v2

• Host: GitHub
• URL: https://github.com/okfn/opendatahandbook
• Owner: okfn
• Created: 2015-02-09T14:27:37.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-01-29T19:39:42.000Z (11 months ago)
• Last Synced: 2024-08-01T12:18:45.842Z (4 months ago)
• Language: SCSS
• Homepage: http://opendatahandbook.org/
• Size: 9.75 MB
• Stars: 197
• Watchers: 51
• Forks: 260
• Open Issues: 79
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - okfn/opendatahandbook - Open Data Handbook v2 (others)

README

        
# opendatahandbook-v2

Repository of http://opendatahandbook.org/

This is a [Jekyll](http://jekyllrb.com/) based site, with pages written in HTML and [Markdown](http://daringfireball.net/projects/markdown/syntax) (specifically [Kramdown](http://kramdown.gettalong.org/syntax.html)), with Markdown being used where possible for ease of editing.

## Editors

Please see the [Contribute](http://opendatahandbook.org/contribute/) section of the site for further instructions.

## Developers

### Dependencies

* [Jekyll](http://jekyllrb.com/)

### 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** - pre-built live site

 - **master** - site in Jekyll form

 - **dev** - minimal content, to speed up building (for development)

 - **theme** - no site specific content, used to create new sites