Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

The know-all app

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

app Remove "Panopticon" from the 'formats not to index' list
config New action to return json of matching artefacts
data Add additional slugs to the migrator
db Migration to change the Charity Commission's slug
doc Convert to a Rails app.
features Updating relating items test for new ui
lib Retry fetching organisations for an artefact on timeout
log Convert to a Rails app.
public Remove old dangling symlinks
script kill obsolete script
test Reflect that documents are only tagged to specialist sub-sectors
vendor Swap out chosen files for gem-provided version
.gitignore Script to create shared Panopticon/Publisher DB.
.ruby-version Bump ruby patch version for security fixes
.travis.yml Exclude master from travis builds.
CONTRIBUTING.md Define contributing guide
Gemfile Bump govuk_content_models to v13.4.0
Gemfile.lock Bump govuk_content_models to v13.4.0
LICENCE.txt Added MIT licence
README.md Add section to README on indexing in development
Rakefile Use London timezone, not UTC
config.ru Convert to a Rails app.
jenkins.sh jenkins.sh should abort on error
jenkins_branches.sh Add branch build script
startup.sh Kill off some more trailing whitespace.
README.md

Panopticon

The GOV.UK content platform has been built with a focus on tools over content. That is manifest in the existence of numerous small applications that provide focussed solutions to specific user needs, or offer a suite of similar but distinct solutions; alongside the 'publisher/frontend' editorial tools there are apps like 'smart answers', 'planners', and so on.

To bring that all together as a single site a single interface was required to attach consistent metadata to the pieces, connect them together as 'related items' and generally have a complete overview of all the solutions/artefacts in the system. That's this app: Panopticon.

Interfaces

Panopticon provides:

  • an admin UI where items can be created and their metadata edited. This is authenticated in conjunction with sign-on-o-tron.
  • a writeable API where applications can register the content they provide. This is authenticated using OAuth2.
  • a read API for retrieving metadata about a given item

Importing organisation tags

Panopticon includes a Rake task to create tags for each organisation from the Whitehall app. To run this in the development environment, the production data source can be used, so that there is no need to have an up-to-date Whitehall database.

PLEK_SERVICE_WHITEHALL_ADMIN_URI=https://www.gov.uk/ bundle exec rake organisations:import

Indexing artefacts in search

Panopticon includes observers which will index, update or delete records in the search index when an artefact is updated. It expects an instance of Rummager to be present.

Indexing is disabled by default in the development environment. To turn indexing on, set the UPDATE_SEARCH environment variable when starting Panopticon.

Something went wrong with that request. Please try again.