A long-lived project that still receives updates
Gem to share document type groupings
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

 Project Readme

GOV.UK document types

This gem contains the "document supertypes" for GOV.UK. Supertypes are groupings of document types.

https://docs.publishing.service.gov.uk/document-types.html

Usage

Find the supertypes for a document type:

supertypes = GovukDocumentTypes.supertypes(document_type: "detailed_guide")
supertypes["content_purpose_subgroup"]
=> "guidance"

Find the document types for a supertype:

GovukDocumentTypes.supergroup_document_types("policy_and_engagement")
=> ["case_study", "closed_consultation", "consultation_outcome", "impact_assessment", "open_consultation", "policy_paper"]

How to add or update a supertype

  1. Add it to data/supertypes.yml in this gem and release a new version
  2. Bump the gem version across GOV.UK apps using Dependabot
  3. Run the rummager:update_supertypes rake task in Search-api to set the correct supertypes in each document in the Elasticsearch indices. Do this after bumping the gem version because this rake task uses information in the gem to find the correct supertype for the document_type defined in each document.

Running the test suite

bundle exec rake

License

MIT License