Specialist Publisher

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. MySQL 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

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

Nomenclature

• Format: Category of a Document. Format names are listed in the Live Examples section above and include MAIB Reports and CMA 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 and document_type. It also contains the facets and their possible values for each document_type which are displayed by _form.html.erb.

Technical documentation

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.

Running the test suite

$ bundle exec rake

Running the app alongside finder-frontend

To test the document lifecycle end-to-end, from creating a document to viewing it in the finder, follow the steps in the GOV.UK Docker README.

Further documentation

• Email alerts
• Rake tasks
• Creating and editing specialist document types
• Updating existing organisation data
• Historical info about migrating to use the Publishing API
• C4 context diagram

Licence

MIT License