Application: collections

Serves GOV.UK navigation pages, browse, topic, step-by-steps & services and information pages.

• GitHub: collections
• Ownership: #govuk-navigation-tech
• Category: Frontend apps
• Links:
  • Sentry (error tracking)
  • App dashboard: request rates, errors, durations
  • Component guide
  • Kibana App Logs (Production, last 3 hours)
  • Kibana Worker Logs (Production, last 3 hours)
  • Argo CD (collections)
  • Argo CD (draft-collections)

Example pages rendered by collections

• Visas and immigration
• Driving and transport
• Vehicle tax, MOT and insurance
• Get Tax-Free Childcare: step by step
• Driving licences
• Benefits
• Visit the UK
• Tell DVLA you’ve changed address: step by step
• Work in the UK
• What you need to do

README

Collections serves the GOV.UK navigation pages and organisation pages. Search API is used to make the pages dynamic e.g. the latest changes for Topics, Organisations and Mainstream browse pages.

At time of writing, it also serves the priority campaign pages. See the Campaign pages manual for more details.

Live examples

• Browse page: gov.uk/browse
• Topic page: gov.uk/oil-and-gas
• Subtopic page: gov.uk/oil-and-gas/fields-and-wells
• Taxonomy page: gov.uk/education
• Worldwide taxonomy page: gov.uk/world/japan
• Organisation index page: gov.uk/government/organisations
• Organisation page: gov.uk/government/organisations/cabinet-office
• Step by step page: gov.uk/learn-to-drive-a-car
• Past Prime Minister: gov.uk/government/history/past-prime-ministers/tony-blair
• World index page: gov.uk/world

Nomenclature

Topics

• Curated list: a group of content tagged to a subtopic that has been curated into a named list.
• Topic: a named group of sub-topics. (A deprecated name for this is “specialist sector”.)
• Sub-topic: a group of content within a topic. (A deprecated name for this is “specialist sub-sector”.)

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 test suite

bundle exec rake

To test a single file:

bundle exec rails test test/unit/application_helper_test.rb

To run JavaScript tests (only):

bundle exec rake jasmine

Pact tests

Collections Organisations API has a pact with GDS API Adapters.

See the guidance on Pact testing for how to run and modify the tests.

Further documentation

• Taxonomy pages
• Campaign pages
• API endpoints and consumers

Licence

MIT License