Application: manuals-frontend

Serves manuals on GOV.UK

Ownership

#govuk-platform-health owns the application and is responsible for updating its dependencies.

Hosting

The production version of this application is hosted on AWS.

SSH Access (AWS)

gds govuk connect ssh -e integration draft_frontend
gds govuk connect ssh -e staging aws/draft_frontend
gds govuk connect ssh -e production aws/draft_frontend

Run a rake task

• Run a Rake task on Integration
• Run a Rake task on Staging
• ⚠️ Run a Rake task on Production ⚠️

Links

• GitHub repo
• Sentry (error tracking)
• Puppet configuration
• Deploy scripts
• Deployment dashboard
• Publishing E2E scenarios (warning: not all apps have E2E tests)

Example pages rendered by manuals-frontend

• Working safely during coronavirus (COVID-19)
• Close contact services
• Restaurants, pubs, bars and takeaway services
• Hotels and other guest accommodation
• Offices and contact centres
• The visitor economy
• 5 steps to working safely
• Shops and branches
• Other people’s homes
• Immigration Rules Appendix K: shortage occupation list

README

Warning The content below is pulled in directly from the repository.
Links might not function properly.

Purpose

Front-end app for the manuals format on GOV.UK

Live examples

• gov.uk/guidance/content-design
• gov.uk/hmrc-internal-manuals/pensions-tax-manual

Nomenclature

• Manuals – documents published using github.com/alphagov/manuals-publisher.
• HMRC Manuals – Manuals published by HMRC and populated via their API: github.com/alphagov/hmrc-manuals-api.

Dependencies

• https://github.com/alphagov/static – Provides static assets (JS/CSS)
• https://github.com/alphagov/content-store – Provides content

Installation and running

In a terminal, run:

./startup.sh

or using bowler:

bowl manuals-frontend

If you are using the GDS development virtual machine then the application will be available on the host at http://manuals-frontend.dev.gov.uk/

Running the tests

The test suite includes testing against govuk-content-schemas, so you will need a copy of this repo on your file system. By default this should be in a sibling directory to your project. Alternatively, you can specify their location with the GOVUK_CONTENT_SCHEMAS_PATH environment variable.

jasmine tests are mounted at http://manuals-frontend.dev.gov.uk/specs

All tests can be run using bundle exec rake as well.

Viewing a manual

You can see the content design manual at http://manuals-frontend.dev.gov.uk/guidance/content-design

Publishing a manual on dev

Manuals are published using manuals-publisher to publish a manual run manuals-publisher (instructions here: https://github.com/alphagov/manuals-publisher), publish a manual, and you should then be able to view it on manuals-frontend. If you have replicated from preview recently then you should be able to see currently published manuals at http://manuals-frontend.dev.gov.uk/[preview-slug] too.