Application: manuals-publisher

Publishes manuals on GOV.UK

• GitHub: manuals-publisher
• Ownership: #govuk-whitehall-experience-tech
• Category: Publishing apps
• Links:
  • manuals-publisher.publishing.service.gov.uk
  • Sentry (error tracking)
  • App dashboard: request rates, errors, durations
  • Kibana App Logs (Production, last 3 hours)
  • Kibana Worker Logs (Production, last 3 hours)
  • Argo CD (manuals-publisher)

Example pages published by manuals-publisher

• MOT inspection manual: cars and passenger vehicles
• MOT testing guide for test stations
• The Highway Code
• Introduction
• 5. Axles, wheels, tyres and suspension
• 1. Brakes
• 6. Body, structure and attachments
• Immigration Rules
• 4. Lamps, reflectors and electrical equipment
• 8. Nuisance

README

Publishing app for manuals. E.g. The Highway Code.

Nomenclature

• Manual: Parent document which is made up of a number of sections
• Section: Individual segment / page of a Manual
• Attachment: File attachment which can be added to a section

Technical documentation

This is a Ruby on Rails app, and should follow our Rails app conventions.

You can use the GOV.UK Docker environment to run the application and its tests with all the necessary dependencies. Follow the usage instructions to get started.

Running the test suite

$ bundle exec rake

Documentation

• Manuals Publisher Data Model
• Manual and Section Edition Workflow

2017 Migration Project Archive

• Introduction
• History of the development of the application
• Current state of the application
• Information about Rake tasks
• Possible next steps for development
• Notes on investigation into fully migrating app with respect to Publishing API

Licence

MIT License