Application: hmrc-manuals-api

API for HMRC to publish manuals to 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 backend
gds govuk connect ssh -e staging aws/backend
gds govuk connect ssh -e production aws/backend

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

Relevant manual pages

• Uptime Metrics

Example pages published by hmrc-manuals-api

• Capital Gains Manual
• IEIM402040 - Reportable Information: Tax Identification Number
• Pensions Tax Manual
• EIM31800 - Deductions: travel expenses: general: contents
• CG60201C - Capital Gains Manual: Reliefs: contents
• Property Income Manual
• RDRM12000 - Residence: The SRT: Split year treatment: Contents
• RDRM11500 - Residence: The SRT: The ties tests: Contents
• SDLTM09730 - SDLT - higher rates for additional dwellings: Contents
• DT2140PP - Guidance by country: contents

README

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

This app provides URLs for pushing HMRC manuals to the GOV.UK Publishing API.

Nomenclature

• Manual: HMRC manual with title and description, contains many Sections. See Adding or updating a manual for more details. Before adding a manual through the api, a new slug should be added to the list of known slugs.

• Section: Sections can contain sub-sections and/or a content body. See Adding or updating a section for more details.

Adding a new slug

Before adding a new manual through the api, the slug for the manual must be added to /config/initializers/known_manual_slugs.rb and the application re-deployed.

The workflow for this is likely to be initiated by a zendesk ticket raised by HMRC with the new slug. A developer can then add the slug and re-deploy the application and inform HMRC that the slug is ready to be published against.

Technical documentation

Provides an API for a system built by HMRC to publish tax manuals onto GOV.UK. In many ways it is analogous to a backend/admin app for publishing on GOV.UK. Content which passes validation and checks for unsanitary content is submitted to the GOV.UK Publishing API application. The application does not have a database itself. An HMRC manual consists of two document types: the manual itself and manual sections.

See the extended documentation for details:

• Connecting to the API
• Adding or updating a manual
• Adding or updating a section
• Responses to PUT requests
• Slugs, Section Ids and Urls
• Content Ids
• Markup
• Manual Tags
• Removing published manuals
• Testing publishing in the GOVUK dev vm
• Managing manuals and sections with rake

Dependencies

• alphagov/search-api: allows document sections to be retrieved
• alphagov/publishing-api: allows documents to be published to the Publishing queue

Running the application

./startup.sh

This runs bundle install to install dependencies and runs the app on port 3071.

When using the GOV.UK development VM use bowl hmrc-manuals-api in the Dev VM development directory. The app will be available at http://hmrc-manuals-api.dev.gov.uk/.

Running the test suite

bundle exec rake

Any deviations from idiomatic Rails/Go etc.

The application does not have a database itself, it sends on requests to the Publishing API.

Example API output

Responses to PUT requests

Licence

MIT License