GOV.UK Developer Docs
? https://docs.publishing.service.gov.uk
Technical documentation
This is a static site generated with Middleman.
Tech docs template
This project uses alphagov/tech-docs-template.
This means that some of the files (like the CSS, javascripts and layouts) are
managed in the template and are not supposed to be modified here. Any project-specific
Ruby code needs to go into /app.
You can pull down the latest version of the template by running:
bin/update
Dependencies
- Ruby
Running locally
The first time you'll need to bundle:
bundle install
To run the app locally:
./startup.sh
The app will appear at http://localhost:4567/
You may need a GitHub auth token if you find yourself rate limited. You can create one here:
https://github.com/settings/tokens/new
It doesn't need any permissions.
Use it like this:
export GITHUB_TOKEN=somethingsomething
./startup.sh
Building the project
Build the site with:
NO_CONTRACTS=true bundle exec middleman build
This will create a bunch of static files in /build.
Testing
bundle exec rake
Deployment
This project is re-deployed by a production Jenkins task every hour between 9am and 7pm (to pick up external
changes). It is hosted on S3.
Pre-commit hooks
There are pre-commit hooks available to help when creating or editing markdown.
Install pre-commit and the vale linter:
brew install vale pre-commit
pre-commit install