https://github.com/alphagov/manuals-publisher
Publishes manuals on GOV.UK
https://github.com/alphagov/manuals-publisher
admin container govuk publisher
Last synced: 6 months ago
JSON representation
Publishes manuals on GOV.UK
- Host: GitHub
- URL: https://github.com/alphagov/manuals-publisher
- Owner: alphagov
- License: mit
- Created: 2014-01-23T15:21:42.000Z (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T15:12:37.000Z (6 months ago)
- Last Synced: 2025-05-08T22:49:35.357Z (6 months ago)
- Topics: admin, container, govuk, publisher
- Language: Ruby
- Homepage: https://docs.publishing.service.gov.uk/apps/manuals-publisher.html
- Size: 11 MB
- Stars: 7
- Watchers: 66
- Forks: 16
- Open Issues: 94
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Manuals publisher
Publishing app for manuals. E.g. [The Highway Code].
## Nomenclature
* Manual: Parent document which is made up of a number of sections
* Section: Individual segment / page of a Manual
* Attachment: File attachment which can be added to a section
## Technical documentation
This is a Ruby on Rails app, and should follow [our Rails app
conventions][conventions].
You can use the [GOV.UK Docker environment][govuk-docker] to run the
application and its tests with all the necessary dependencies. Follow the
[usage instructions][docker-usage] to get started.
### Running the test suite
```
$ bundle exec rake
```
## Documentation
* [Manuals Publisher Data Model](docs/data-model.md)
* [Manual and Section Edition Workflow](docs/edition-workflow.md)
## 2017 Migration Project Archive
* [Introduction](docs/2017-migration-project-archive/start-here.md)
* [History of the development of the application](docs/2017-migration-project-archive/history.md)
* [Current state of the application](docs/2017-migration-project-archive/current-state.md)
* [Information about Rake tasks](docs/2017-migration-project-archive/rake-tasks.md)
* [Possible next steps for development](docs/2017-migration-project-archive/next-steps.md)
* [Notes on investigation into fully migrating app with respect to Publishing API](docs/2017-migration-project-archive/fully-migrated-spike.md)
[The Highway Code]: https://www.gov.uk/guidance/the-highway-code
[conventions]: https://docs.publishing.service.gov.uk/manual/conventions-for-rails-applications.html
[govuk-docker]: https://github.com/alphagov/govuk-docker
[docker-usage]: https://github.com/alphagov/govuk-docker#usage
## Licence
[MIT License](LICENCE)