Skip to main content

Application: support

Forms to raise Zendesk tickets to be used by Government personnel on GOV.UK

GitHub
support
Ownership
#govuk-platform-health
Hosting
AWS, on the backend machine class
Continuously deployed?
Yes
Rake tasks
Integration, Staging or ⚠️ Production ⚠️

README

This app:

  • Presents anonymous feedback about pages on GOV.UK in a “feedback explorer”. Anonymous feedback is collected via the Feedback app and retrieved from the Support API.

  • Exposes internal APIs to create Zendesk tickets e.g. via the Feedback app. Tickets are created using the gds_zendesk gem.

  • Hosts internal forms for publishers to create Zendesk tickets, as well as emergency contact info. Emergency contacts are secret and retrieved from an environment variable at runtime.

Nomenclature

  • Feedback: All the data received from contact forms is considered to be “feedback” of some form or other and relates to pages published on GOV.UK.
  • Anonymous Contact: Part of the feedback collected by this app is anonymous, when it’s submitted via an anonymous contact form in the feedback app.
  • Named Contact: In contrast with the Anonymous Contact feedback, this is submitted via a form that will require you to identify yourself.

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

Running the worker

Zendesk tickets are raised in the background using a Sidekiq worker.

To start the background worker:

bundle exec rake jobs:work

Licence

MIT License