Skip to content

alphagov/service-manual-publisher

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
March 24, 2022 11:49
February 2, 2023 15:59
db
April 19, 2022 14:06
March 23, 2021 10:14
log
October 6, 2015 15:42
October 6, 2015 15:42
January 15, 2023 15:25
September 29, 2022 18:43
September 29, 2022 18:13

Service Manual Publisher

Service Manual Publisher is used for publishing and maintaining https://www.gov.uk/service-manual. This application, together with Service Manual Frontend replaced the previous Jekyll-based service manual.

Nomenclature

  • Guide: A guide is the main document format used for manuals.
  • Guide Community: A profile page that represents the community who curate a collection of guides.
  • Topic: A collection of guides.
  • Point: A point from the service standard.

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

Further documentation

There is some disparity between the content as it appears in the database, and the content as it appears in the publishing api. This will need to be addressed if we switch to using the Publishing API as our main data store in the future.

The Service manual's guide pages have a nested URL structure which is unusual for GOV.UK. The pros and cons to the nested URL structure are retrospectively documented.

Licence

MIT License