Publishing App for Specialist Documents.
This application does not store documents in a database of its own. Instead it uses Publishing API to store and retrieve documents. MongoDB is used for storing local user records.
Formats can be flagged as
pre-production (only publishable on development and integration). Read Creating and editing specialist document typesfor details.
Some live examples
- AAIB Reports
- CMA Cases
- Countryside Stewardship Grants
- Drug Safety Update
- International Development Funds
- Medical Safety Alerts
- MAIB Reports
- RAIB Reports
- Research For Development Outputs
- UK Market Conformity Assessment Bodies
- Format: Category of a Document. Format names are listed in the
Live Examplessection above and include
- Finder: Sometimes Formats are referred to as Finders. They are called 'Finders' because each one of them creates a finder on GOV.UK, e.g. https://www.gov.uk/raib-reports. The formats are served by Finder Frontend.
- Document: Specialist Documents are created by Government editors and can be published to GOV.UK. Documents differ depending on their format, largely determined by the format's schema.
- Schema: JSON files defining attributes for each format, including
document_type. It also contains the facets and their possible values for each
document_typewhich are displayed by
This is a Ruby on Rails app, and should follow our Rails app conventions.
Use GOV.UK Docker to run any commands that follow.
Before running the app
You may find that you can't see any documents after replicating data. To fix this, you need to grant user permissions in this application:
bundle exec rake permissions:grant['Joanne Bloggs'] # Or whichever user you're logged in as.
Running the test suite
$ bundle exec rake
- Email alerts
- Rake tasks
- Creating and editing specialist document types
- Updating existing organisation data
- Historical info about migrating to use the Publishing API