https://github.com/alphagov/service-manual-publisher
Publishes the Service Manual on GOV.UK
https://github.com/alphagov/service-manual-publisher
admin container gds-service-manual govuk publisher
Last synced: 6 months ago
JSON representation
Publishes the Service Manual on GOV.UK
- Host: GitHub
- URL: https://github.com/alphagov/service-manual-publisher
- Owner: alphagov
- License: mit
- Created: 2015-10-06T14:45:26.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2025-04-29T14:11:32.000Z (6 months ago)
- Last Synced: 2025-04-29T15:25:50.381Z (6 months ago)
- Topics: admin, container, gds-service-manual, govuk, publisher
- Language: Ruby
- Homepage: https://docs.publishing.service.gov.uk/apps/service-manual-publisher.html
- Size: 5.16 MB
- Stars: 11
- Watchers: 61
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/alphagov/service-manual-frontend) replaced the previous [Jekyll-based service manual](https://github.com/alphagov/government-service-design-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](https://docs.publishing.service.gov.uk/manual/conventions-for-rails-applications.html).
You can use the [GOV.UK Docker environment](https://github.com/alphagov/govuk-docker) to run the application and its tests with all the necessary dependencies. Follow [the usage instructions](https://github.com/alphagov/govuk-docker#usage) to get started.
**Use GOV.UK Docker to run any commands that follow.**
### Running the test suite
```sh
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](docs/arch/002-disparity-between-database-and-publishing-api.md). 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](docs/arch/001-nested-url-structure.md).
## Licence
[MIT License](LICENCE)