Application: whitehall

Publishes government content on GOV.UK

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

Relevant manual pages

• Add an organisation’s brand colour
• Rename a country
• Uptime Metrics

Example pages published by whitehall

• Departments, agencies and public bodies
• Ministers
• Find a British embassy, high commission or consulate
• All ministers and senior officials on GOV.UK
• The Rt Hon Rishi Sunak MP
• Prime Minister
• The Rt Hon Suella Braverman KC MP
• Secretary of State for the Home Department
• The Rt Hon Claire Coutinho MP
• Secretary of State for Education

README

Whitehall (also known as ‘Whitehall Admin’ or ‘Whitehall Publisher’) is used by publishers to create and manage content (e.g. http://whitehall-admin.dev.gov.uk/government/admin/news/new).

Running the Application

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

Nomenclature

• Govspeak A variation of Markdown used throughout whitehall as the general publishing format

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

These commands assume you have the GOV.UK Docker environment running and its binaries in your PATH.

# run all the test suites
govuk-docker-run bundle exec rake

Javascript unit tests can also be run separately:

# run all the JavaScript tests
govuk-docker-run bundle exec rake jasmine

Further documentation

See the docs/ directory.

• Content Audit Trail
• CSS
• Edition model
• Edition workflow
• How to publish a finder in whitehall
• Internationalisation
• JavaScript
• Search Indexing
• Timestamps
• Troubleshooting
• Adding a data migration

Licence

MIT License