Application: manuals-publisher

Publishes manuals on GOV.UK

• GitHub: manuals-publisher
• Ownership: #govuk-publishing-experience-tech
• Hosting: AWS (EKS)
• Category: Publishing apps
• Links:
  • manuals-publisher.publishing.service.gov.uk
  • Sentry (error tracking)
  • Deployment dashboard
  • Argo CD (manuals-publisher)

Relevant manual pages

• Uptime Metrics

Example pages published by manuals-publisher

• The Highway Code
• MOT inspection manual: cars and passenger vehicles
• Immigration Rules
• Find a Skills Bootcamp
• Traffic signs
• 4. Lamps, reflectors and electrical equipment
• Car driving test
• Immigration Rules Appendix Skilled Occupations
• 5. Axles, wheels, tyres and suspension
• General rules, techniques and advice for all drivers and riders (103 to 158)

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

Licence

MIT License