App that holds some of the content on GOV.UK. Is being deprecated.
Ruby HTML JavaScript CSS Cucumber Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db/migrate
docs
features
lib
log
public Remove old dangling symlinks Jul 1, 2012
script
test
.gitignore
.ruby-version
.travis.yml
CONTRIBUTING.md Define contributing guide Nov 29, 2013
Gemfile
Gemfile.lock
LICENCE.txt Correct copyright notice Feb 16, 2015
Procfile
README.md
Rakefile
config.ru
jenkins.sh
jenkins_branches.sh
startup.sh

README.md

Panopticon

Panopticon is an application originally built to act as a central repository for content on GOV.UK. It is being deprecated.

Screenshot of Panopticon, April 2016

Live examples

Features & deprecation

Feature Replacement Status
Specifying legacy source Feature removed Done
Tagging documents Any document on GOV.UK will be taggable in content-tagger Partially done
Registering routes The content-store registers routes for any content-item that doesn't have the "placeholder" format Partially done
Creating tags (via API) Creating tags is done in collections-publisher. Once nothing is using tags from the content-api this feature can be removed Partially done
Creating artefacts for mainstream publisher To be decided Not started
Specifying related items To be decided Not started
Sending data to Rummager The publishing-api will send the content item to the message queue, which will be picked up by rummager Not started
Syncing links from publishing-api (see) Frontend apps will start using the content-store for the taggings Not started
See a history of document changes To be decided Not started

Nomenclature

  • Artefact: a document on GOV.UK.

Technical documentation

Panopticon provides three interfaces:

  • An admin UI where items can be created and their metadata edited
  • A writeable API where applications can register the content they provide
  • A read API for retrieving metadata about a given item

Panopticon shares a database with Mainstream Publisher, Content API and Travel Advice Publisher. They share application code via the govuk_content_models gem.

Dependencies

Running the application

In the development VM:

cd /var/govuk/development && bowl panopticon

The app with appear at http://panopticon.dev.gov.uk/.

Running the message queue

Frontend apps rely on the tagging data in content_api to show breadcrumbs. Panopticon listens to any changes in publishing-api via the message queue and saves this data.

To run the message queue:

govuk_setenv panopticon bundle exec rake message_queue:consumer

Running the test suite

bundle exec rake

Licence

MIT License