Explore education statistics API documentation

⚠️ This repository is no longer maintained ⚠️

The documentation in this repository has been moved to the Explore education statistics repository. Consequently, the docs in this repository are no longer maintained and may be out of date.

---

This repository is used to generate the documentation website for the Explore education statistics API. It is based on the GOV.UK Technical Documentation Template.

Pre-requisites

The following pre-requisite dependencies are required to get started:

• Node.js v20+ (can be installed with nvm or fnm)
• Ruby v3.3.5 (can be installed with rbenv or rvm)

As always, it's advisable to install any versions using a version manager to make it easier to upgrade and keep aligned with the project.

Ubuntu

If you are using Ubuntu, you may need to install the following dependencies before you can install Ruby and its required gems:

sudo apt install libssl-dev libyaml-dev

Getting started

Once the pre-requisites have been installed, follow these steps:

1. Install the project's Ruby dependencies:

   bundle install

2. Start the development server:

   bundle exec middleman

   This will start the Middleman development server on https://localhost:4567.

3. Optional. To automatically refresh the browser upon code changes, install the LiveReload browser extension.

For further guidance on how to develop this documentation, please visit the Technical Documentation Template website.

Publishing changes

GitHub Actions automatically publishes changes merged into the main branch of this repository.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.