Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
ci
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Reliability Engineering Team Manual Build Status

Technical documentation

This is a static site generated with Middleman.

Tech docs template

This project uses alphagov/tech-docs-template.

Dependencies

  • Ruby.
  • The middleman gem.

Making changes

To make changes, edit the source files in the source directory. To add a completely new page, create a file with a .html.md extension in the /source directory.

Whilst writing documentation we can run a middleman server to preview how the published version will look in the browser. After saving a change the preview in the browser will automatically refresh. Run bundle exec middleman server, then the website will be available locally at http://localhost:4567.

Building the project

Build the site with:

    bundle exec middleman build

This will create a bunch of static files in /build.

Deployment

This is deployed automatically to the PaaS via the multi-tenant Concourse via the internal-apps pipeline in the tech-ops repo. (The Autom8 team is a good place to start with any questions).

Licence

MIT License

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

The styles are copied from https://github.com/alphagov/govuk-developer-docs/tree/bc94d39dce23236fc61238464010713daf5213f9/styles