govuk_document_types 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b27d31bc70d8664edb850438dffb0244fa920b9f8f794a51353cd59cc1a4200
-  data.tar.gz: 07a577cadf22da3c379bb19336a7fd0990a5ac3808798f3b0567b7c6339ea8be
+  metadata.gz: fdc53275544b5c4bb4d790621c9e925af6410a748c42385faf08782358780ee1
+  data.tar.gz: 0a4cbc40a74aea0c8d16936aa1b4da56ebc6721d70a7fe5b214cd5517a1938ba
 SHA512:
-  metadata.gz: 4cf7c1a0c355df521179409c029286e5c7b17989b34dc08322c45409783bb4ba7271af7a1b4a92b7126f7e0fbd622e9399011decf7773cf74c46c8312699d984
-  data.tar.gz: 1a4bca6b8cf6d15f4ea82c5dada03ee01c5f92dd2a94e71e9bde5c6c16bea448a572def0961cab68ea9c9ff36994e076194301fb37186136fb0ff7f712dfb27c
+  metadata.gz: a0432c2a813cc575aae6e5be273884ba88618f6fd74e1bbd92377141effddcdbf4f48573309671afbe126b8d8b46be243c687cec84e3e8f19bd6cc60ff3cbb48
+  data.tar.gz: c24d17736456dd9a9050cb632e1aced1228f9fbc86aece00567c7d985cbeb8b7f9b70657d80c62902c290ddf50b218b6d590ce2a18573c1e2d8db80229517565

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-# Unreleased
+# 0.9.1
+
+* Removed `contact` from the guidance group.
 
 # 0.9.0
 

data/README.md

@@ -5,26 +5,29 @@ of document types.
 
 https://docs.publishing.service.gov.uk/document-types.html
 
-This gem is only to be used in [publishing-api][publishing-api] and
-[rummager][rummager]. **Don't use it in your project**.
+## Usage
 
-## Long term vision
 
-This gem is used to share the canonical list of supertypes between rummager and publishing-api. We're currently migrating to a new system of indexing where rummager gets all data from the publishing-api (via a message queue). Once that work is completed this repo should be retired and the canonical list should be moved to either [govuk-content-schemas][] for use in the publishing-api, or be moved into publishing-api directly.
+Find the supertypes for a document type:
 
-## How to add a supertype
+```rb
+supertypes = GovukDocumentTypes.supertypes(document_type: "detailed_guide")
+supertypes["content_purpose_subgroup"]
+=> "guidance"
+```
 
-1. Add it to [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version
-2. [Add the supertype][rummager-pr] in Rummager so that it can be indexed and searched with. Bump the gem in Rummager.
-3. [Add the type to content-schemas][schemas-pr]
-4. [Add the type to the content-store][content-store-pr]
-5. Bump the gem version in [publishing-api][publishing-api]
+Find the document types for a supertype:
 
-## How to update a supertype
+```rb
+GovukDocumentTypes.supergroup_document_types("policy_and_engagement")
+=> ["case_study", "closed_consultation", "consultation_outcome", "impact_assessment", "open_consultation", "policy_paper"]
+```
 
-1. Update [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version.
-2. Bump the gem version in [rummager][rummager]. Rummager's nightly re-indexing will pick up your changes.
-3. Bump the gem version in [publishing-api][publishing-api]. All documents have to be sent to the content-store again for your changes to be picked up.
+## How to add or update a supertype
+
+1. Add it to [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version
+2. Bump the gem version across GOV.UK apps using [Dependabot](https://app.dependabot.com/)
+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
 
@@ -35,11 +38,3 @@ bundle exec rake
 ## License
 
 [MIT License](LICENSE.txt)
-
-[rummager-pr]: https://github.com/alphagov/rummager/pull/756
-[govuk-content-schemas]: https://github.com/alphagov/govuk-content-schemas
-[schemas-pr]: https://github.com/alphagov/govuk-content-schemas/pull/551
-[content-store-pr]: https://github.com/alphagov/content-store/pull/268
-
-[publishing-api]: https://github.com/alphagov/publishing-api
-[rummager]: https://github.com/alphagov/rummager

data/data/supertypes.yml

@@ -161,8 +161,6 @@ content_purpose_document_supertype:
         # "Tags"
         - document_collection
         - mainstream_browse_page
-        - policy
-        - policy_area
         - taxon
         - topic
 
@@ -224,8 +222,6 @@ user_journey_document_supertype:
         - license_finder
         - mainstream_browse_page
         - organisation
-        - policy
-        - policy_area
         - search
         - service_manual_homepage
         - service_manual_topic
@@ -441,7 +437,6 @@ content_purpose_subgroup:
         - manual_section
         - guidance
         - map
-        - contact
         - calendar
         - statutory_guidance
         - notice
@@ -543,7 +538,6 @@ content_purpose_supergroup:
         - manual_section
         - guidance
         - map
-        - contact
         - calendar
         - statutory_guidance
         - notice
@@ -584,7 +578,3 @@ content_purpose_supergroup:
         - aaib_report
         - raib_report
         - maib_report
-
-
-
-

data/lib/govuk_document_types/version.rb

@@ -1,3 +1,3 @@
 module GovukDocumentTypes
-  VERSION = "0.9.0".freeze
+  VERSION = "0.9.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_document_types
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2019-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -111,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Gem to share document type groupings