This repo is now at https://github.com/mysociety/data_portal

(Need to create a non-forked copy so that Github actions could correctly update).

mySociety Data Portal repo - running on JKAN

A lightweight, backend-free open data portal, powered by Jekyll

View at data.mysociety.org

Local Development

There is a docker config that will work locally or on codespaces.

This will then start the rendering process and serve on http://127.0.0.1:4000

Theme

Jkan runs on Jekyll.

Local adaptions to mySociety theme are in sass folder - both that and 'theme/sass' are equally accessible to compiler - so no need for relative paths.

Key template is templates/default.html - this then brings in various mysoc_ includes.

Don't forget to git submodule update --init --recursive to pull down the mySociety styles

Categories

Category information is stored in three places.

1. References in datasets
2. Entries in _data/categories.yml (with additional info like logos, or if they are a highlighted category)
3. Markdown files in /_categories

The final set is generated from the first two to create the static pages for the category pages.

This isn't directly supported by Github Jekyll, so you can generate the markdown files using:

$ ruby script/generate_categories.rb

Or manually create the file when creating/modifying categories.