Application: content-publisher

Publishing application for GOV.UK

• GitHub: content-publisher
• Ownership: #govuk-platform-health
• Hosting: AWS, on the backend machine class
• Continuously deployed?: Yes
• Rake tasks: Run a Rake task on Integration, Staging or ⚠️ Production ⚠️
• Links:
  • Sentry (error tracking)
  • Puppet configuration
  • Deploy scripts
  • Deployment dashboard
  • Publishing E2E scenarios (warning: not all apps have E2E tests)

Imported documents

• Approach to Analytics
• Editing a document’s change history
• History mode
• Importing documents from Whitehall to Content Publisher
• Removing or removing and redirecting a document
• Scheduled publishing
• Testing Strategy
• User Permissions
• /adr
• 1. Record architecture decisions
• 10. Sending email notifiations
• 11. Moving business logic out of controllers
• 12. Rendering File Attachments outside of Govspeak
• 13. Permitted Deletion
• 14. Political and Government Tagging
• 15. Bulk data loading
• 16. Publishing times and change history
• 2: Use local datastore for publisher workflow
• 3. Initial Domain Modelling
• 4. Editing Microcopy
• 5. Avoiding initialisation flickering in HTML
• 6. Tagging Content to Governments
• 7. Minimal Model
• 8. Restricted Deletion
• 9. Modelling history

Example pages published by content-publisher

• JCVI advises on COVID-19 vaccine for people aged under 40
• Limit on mourners at funerals to be removed
• COVID-19 vaccines: further evidence of success
• Confirmed cases of COVID-19 variants identified in UK
• New 95% mortgage scheme launches
• One dose of COVID-19 vaccine can cut household transmission by up to half
• New standard tenancy agreement to help renters with well behaved pets
• JCVI issues new advice on COVID-19 vaccination for pregnant women
• Over £150 million funding to kickstart self building revolution
• Government reforms make it easier and cheaper for leaseholders to buy  their homes 

README

A unified publishing application for content on GOV.UK

Nomenclature

• Content - Some text (and related fields) a user wants to publish
• Revision - A version of a piece of content in a particular locale
• Edition - A revision that is in the Publishing API
• Document - All revisions of a piece of content in a particular locale

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.

Before running the app

The first time you run this application for development, enable debug and pre_release_features permissions:

bundle exec rake development_permissions

To enable them for your GOV.UK account add them to your account in Signon.

Running the test suite

# ruby tests
bundle exec rspec

# JS tests (in console, or in browser)
bundle exec rake jasmine:ci
bundle exec rake jasmine

Our test environment is setup to render ‘real’ error pages, instead of raising an exception. This can make it hard to debug a test failure, as the actual error won’t appear in the test output. Instead, you can see it in log/test.log.

Further documentation

• Approach to analytics
• Editing change note history
• History mode
• Importing documents from Whitehall
• Removing documents
• Scheduled publishing
• Testing strategy
• User permissions

Licence

MIT License