Planning Data Specification

Specifications and other data used to model the data for https://planning.data.gov.uk

• content – source data as Frontmatter Markdown and CSV files
• content/specification – Frontmatter Markdown for technical specifications for providing the data
• content/dataset – Frontmatter Markdown for each dataset on the platform
• content/field – Frontmatter Markdown for each dataset field
• content/datatype – Frontmatter Markdown for field datatypes

This content is used to build:

• specification – the model as CSV files, built from the content available at https://datasette.planning.data.gov.uk/digital_land
• doc – documentation GitHub pages https://digital-land.github.io/specification/ which we expect to move to https://planning.data.gov.uk

Updating the collection

We recommend working in virtual environment before installing the python dependencies:

$ make init
$ make

Creating a new version of a specification

Use the script

    bin/new-version.py --specification [specification name] --version [major|minor|patch]

Use patch when updating descriptions. Use minor when adding or removing fields from datasets. Use major when adding or removing datasets from the specification.

This will create a version directory "vn.n.n" in a subdirectory for the specification.

It will copy the current specifiation markdown to that directory and update the version number in the top level specification markdown. You can then edit the top level file as required.

For example see article-4-direction which has three versions.

article-4-direction.md (this will be file you edit and is latest version)
.
├── v1.1.1
│   └── article-4-direction.md
└── v1.2.2
└── article-4-direction.md

Licence

The software in this project is open source and covered by LICENSE file.

Individual datasets copied into this repository may have specific copyright and licensing, otherwise all content and data in this repository is © Crown copyright and available under the terms of the Open Government 3.0 licence.