Application: manuals-publisher

Publishes manuals on GOV.UK

• GitHub: manuals-publisher
• Ownership: #govuk-platform-health
• Hosting: AWS, on the backend machine class
• Rake tasks: Run a Rake task on Integration, Staging or ⚠️ Production ⚠️
• Links:
  • Sentry (error tracking)
  • Puppet configuration
  • Deploy scripts
  • Deployment dashboard
  • Publishing E2E scenarios (warning: not all apps have E2E tests)

Relevant manual pages

• Uptime Metrics

Imported documents

• Current state
• Fully-migrated spike
• History
• Next steps
• Rake tasks

Example pages published by manuals-publisher

• MOT inspection manual: cars and passenger vehicles
• Working safely during coronavirus (COVID-19)
• Immigration Rules
• The Highway Code
• 4. Lamps, reflectors and electrical equipment
• Offices, factories and labs
• Traffic signs
• 5. Axles, wheels, tyres and suspension
• Car driving test
• 1. Brakes

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

• 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