Application: search-admin

Admin for GOV.UK search

• GitHub: search-admin
• Ownership: #govuk-search
• Category: Supporting apps
• Links:
  • search-admin.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 (search-admin)

Example pages published by search-admin

• Family Procedure Rules - Ministry of Justice
• Points of Light
• Coronavirus (COVID-19) in Scotland - gov.scot
• NHS App - NHS
• Cyber Aware - National Cyber Security Centre
• Dentists - NHS
• Care homes - NHS
• NHS
• Stop and search - Ethnicity facts and figures
• Find your MP - UK Parliament

README

Manages search “best bets” and “external links” along with other search and browse data.

Screenshots

Live example

• https://search-admin.publishing.service.gov.uk/

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.

Use GOV.UK Docker to run any commands that follow.

Running the test suite

bundle exec rake

External links

Run bundle exec rake publish_external_links:publishing_api to send all external links to the publishing API.

Document rake tasks

These rake tasks connect to Google Cloud Platform (GCP) to interact with documents stored in the Discovery Engine datastore.

Authentication is required:

gcloud auth application-default login

For more details see: https://docs.publishing.service.gov.uk/manual/google-cloud-platform-gcp.html#using-the-cli

The rake tasks can be run using the default lite stack, from your search-admin folder:

govuk-docker run bundle exec rake [relevant-rake-task]

Licence

MIT License