whitehall is a Ruby on Rails content management application for content published by government departments and agencies.
- Govspeak A variation of Markdown used throughout whitehall as the general publishing format
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.
Assets are currently handled by whitehall. It handles uploads, virus scanning and serving of assets. There is a current project to migrate whitehall to use Asset Manager.
- alphagov/asset-manager: provides uploading for static files (migration in progress)
- alphagov/publishing-api: documents are sent here, persisted and then requested
- alphagov/rummager: allows documents to be indexed for searching in both finders and site search
$ ./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.
$ bundle exec rake
- Contributing guide
- CSS
- Draft assets
- Edition workflow
- How to publish a finder in whitehall
- Internationalisation
- JavaScript
- Local assets
- Migration sync checks
- Search setup guide
- Testing guide
- Timestamps
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.