There is a step by step guide available here.
Provides a template for publishing a high quality open dataset. Each repository is designed to host a single dataset, consisting of one or more files.
To create a dataset with open data certificate
-
Fork the template repository and rename the repository to something more akin to the dataset you will be publishing. This can be done from the respositories settings menu. At the same time re-enable issues from the same screen.
-
Upload data files into the data/ directory.
-
For each file uploaded you need to add a .data file in the data directory that specifies the metadata for the file, this file should look like the examples and contain the following fields. Note that the category must not be changed from data.
category: data
filename: filename.csv
weight: 2
title: June 2014
description: Transactions in June 2014
type: text/csv
Key:
weight: The position that the file is displayed on the page, 1 being first.
type: The IANA mime type of the file, e.g. text/csv, application/json etc.
-
Edit _config.yml and fill in all the values that describe this dataset, changing the examples
-
Point certificates.theodi.org at the front page of the site and let it automatically fill in values (then add the embed code to _config.yml)
-
Note that many of the certificate fields can be filled in by using the github features that are available under the "Data quality and accuracy" sections.
-
Replace logo.png in the img directory with your own company logo
-
edit css/style.css to change colour schemes of the site.
The Open Data Institute Github Data publisher automatically produces the following:
-
A webpage to host a dataset containing full embedded dcat metadata conforming to this best practice guideline.
-
A datapackage.json file corresponding to the Open Knowledge guideline for producing a tabular data package.