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.
For each of the specialist finder schemas, target_stack
property can be set to draft
to only put the finder content onto the draft stack, and live
to publish the finder to the live
stack
- AAIB Reports
- CMA Cases
- Countryside Stewardship Grants
- Drug Safety Update
- International Development Funds
- Medical Safety Alerts
- MAIB Reports
- RAIB Reports
- Research For Development Outputs
- Format: Category of a Document. Format names are listed in the
Live Examples
section above and includeMAIB Reports
andCMA Cases
. - 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
base_path
,document_noun
anddocument_type
. It also contains the facets and their possible values for eachdocument_type
which are displayed by_form.html.erb
.
This is a Ruby on Rails app, and should follow our Rails app conventions.
You can use the GOV.UK Docker environment to run the application and its tests with all the necessary dependencies. Follow the usage instructions to get started.
Use GOV.UK Docker to run any commands that follow.
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.
$ bundle exec rake