Application: whitehall

Publishes government content on GOV.UK

Ownership

#govuk-platform-health owns the application and is responsible for updating its dependencies.

Hosting

The production version of this application is hosted on AWS.

SSH Access (AWS)

gds govuk connect ssh -e integration whitehall_backend
gds govuk connect ssh -e staging aws/whitehall_backend
gds govuk connect ssh -e production aws/whitehall_backend

Run a rake task

Example pages published by whitehall

README

Warning The content below is pulled in directly from the repository.
Links might not function properly.

whitehall is a Ruby on Rails content management application for content published by government departments and agencies.

Nomenclature

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

Technical documentation

whitehall is a Ruby on Rails app built on a MySQL database. It is deployed in two modes: ‘admin’ for publishers to create and manage content and ‘frontend’ for rendering some content under https://www.gov.uk/government and https://www.gov.uk/world. whitehall also sends most content to the publishing-api and rummager.

Dependencies

alphagov/asset-manager: provides uploading for static files
alphagov/publishing-api: documents are sent here, persisted and then requested
alphagov/search-api: allows documents to be indexed for searching in both finders and site search
alphagov/link-checker-api: checks all the links in an edition on request from the edition show page.

Running the application

$ ./startup.sh

If you are using the GDS development virtual machine then the application will be available on the host at http://whitehall-admin.dev.gov.uk/

Further setup instructions are available in the detailed setup guide.

Running the test suite

$ bundle exec rake

Generating technical documentation

We use YARD for the technical documentation. You can generate a local copy with:

yard server --reload

You can also read the docs on rdoc.info.

Licence

MIT License

Results