Application: manuals-frontend

Serves manuals on GOV.UK

• GitHub: manuals-frontend
• Ownership: #govuk-platform-health
• Hosting: AWS, on the draft_frontend 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)

Example pages rendered by manuals-frontend

• 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

Front-end app for the manuals format on GOV.UK

Nomenclature

• Manuals – documents published using Manuals Publisher.
• HMRC Manuals – Manuals published by HMRC and populated via HMRC Manuals API.
• Sections - individual sub-pages of a Manual or HMRC Manual.

Live examples

• Manual: gov.uk/guidance/content-design
• Manual Section: gov.uk/guidance/content-design/what-is-content-design
• HMRC Manual: gov.uk/hmrc-internal-manuals/pensions-tax-manual
• HMRC Manual Section: gov.uk/hmrc-internal-manuals/pensions-tax-manual/ptm000001

Technical documentation

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

You can use the GOV.UK Docker environment or the local startup.sh script to run the app. Read the guidance on local frontend development to find out more about each approach, before you get started.

If you are using GOV.UK Docker, remember to combine it with the commands that follow. See the GOV.UK Docker usage instructions for examples.

Running the tests

bundle exec rake

License

MIT License