mirror of
https://github.com/alphagov/manuals-publisher.git
synced 2026-09-28 18:00:03 +00:00
Official upstream source mirror. Do not make UH changes here.
- Ruby 78.5%
- HTML 15.3%
- Gherkin 3%
- JavaScript 2.3%
- SCSS 0.8%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .github | ||
| .yarn/releases | ||
| app | ||
| bin | ||
| config | ||
| db | ||
| docs | ||
| features | ||
| lib/tasks | ||
| log | ||
| public | ||
| script | ||
| spec | ||
| .dockerignore | ||
| .gitignore | ||
| .govuk_dependabot_merger.yml | ||
| .rspec | ||
| .rubocop.yml | ||
| .ruby-version | ||
| .yarnrc.yml | ||
| config.ru | ||
| Dockerfile | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENCE | ||
| package.json | ||
| Procfile | ||
| Rakefile | ||
| README.md | ||
| yarn.lock | ||
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.
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.
Running the test suite
$ bundle exec rake
Documentation
2017 Migration Project Archive
- Introduction
- History of the development of the application
- Current state of the application
- Information about Rake tasks
- Possible next steps for development
- Notes on investigation into fully migrating app with respect to Publishing API