govuk_document_types 0.9.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b27d31bc70d8664edb850438dffb0244fa920b9f8f794a51353cd59cc1a4200
-  data.tar.gz: 07a577cadf22da3c379bb19336a7fd0990a5ac3808798f3b0567b7c6339ea8be
+  metadata.gz: 4f789c70349961ccb4ddc415ffc398ef47ab69faf0028bacb93329ab8ddc2c2f
+  data.tar.gz: ac205000cf9fc8c16864126521efa05b7d8144b818092489ed92b3808e582bd7
 SHA512:
-  metadata.gz: 4cf7c1a0c355df521179409c029286e5c7b17989b34dc08322c45409783bb4ba7271af7a1b4a92b7126f7e0fbd622e9399011decf7773cf74c46c8312699d984
-  data.tar.gz: 1a4bca6b8cf6d15f4ea82c5dada03ee01c5f92dd2a94e71e9bde5c6c16bea448a572def0961cab68ea9c9ff36994e076194301fb37186136fb0ff7f712dfb27c
+  metadata.gz: '012833c1d2ad5b68779578a1544e2344819a0da9ee67a9d0cf345e4163fdae7c5e6fe4855f476fdb5c58087e695946bdcb983a3d37d500ea05fca7024b32d61f'
+  data.tar.gz: 1d0f62f78a9f0fb884ae3010d5fac1c40e79c80087fab0c68e4a5acb740ee0a381cb772016e7bd0aa2ed3c2ceddf0a085f63c49d29b1b4fc06df929b3ae26a1f

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.6

data/CHANGELOG.md

@@ -1,4 +1,23 @@
-# Unreleased
+# 1.0.1
+
+* Remove Flood & Coastal Erosion Risk Management Report (FCERM) Research Report from research supergroup
+
+# 1.0.0
+
+* Remove deprecated supertypes
+* Add Flood & Coastal Erosion Risk Management Report (FCERM) Research Report to research supergroup
+
+# 0.9.3
+
+* Added `standard` subtype to the guidance group
+
+# 0.9.2
+
+* Moved `case_study` from policy papers and consultations to news and comms.
+
+# 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

@@ -1,215 +1,3 @@
-navigation_document_supertype:
-  name: "Navigation document type"
-  description: "Used to filter pages on the new taxonomy-based navigation pages"
-  default: other
-  items:
-    - id: guidance
-      document_types:
-        - answer
-        - contact
-        - detailed_guide
-        - document_collection
-        - form
-        - guidance
-        - guide
-        - licence
-        - local_transaction
-        - manual
-        - map
-        - place
-        - promotional
-        - regulation
-        - simple_smart_answer
-        - smart_answer
-        - statutory_guidance
-        - transaction
-        - travel_advice
-
-content_purpose_document_supertype:
-  name: "Content purpose"
-  description: "DEPRECATED - Please use `content_purpose_subgroup`. The team grouped document types that serve a similar purpose for users into top-level content groups. In time, this information could be used to serve relevant links into a content page sidebar and pull feeds of specific content groups into navigation pages."
-  default: other
-  items:
-    - id: updates-and-alerts
-      description: To provide time-based information on a new thing (alert) or something that's already happened (update)
-      document_types:
-        - drug_safety_update
-        - fatality_notice
-        - medical_safety_alert
-        - national_statistics_announcement
-        - official_statistics_announcement
-        - staff_update
-        - statistics_announcement
-
-    - id: news
-      description: To communicate what government is doing (non-urgent)
-      document_types:
-        - case_study
-        - correspondence # Also used for other things
-        - news_article
-        - news_story
-        - press_release
-        - world_location_news_article
-        - world_news_story
-
-    - id: resources
-      document_types:
-        - map
-        - promotional
-
-    - id: speeches-and-statements
-      document_types:
-        - authored_article
-        - oral_statement
-        - speech
-        - written_statement
-
-    - id: guidance
-      description: To provide information that prepares the user for doing a thing (without the need to share any personal information).
-      document_types:
-        - answer
-        - calendar
-        - detailed_guide
-        - guidance
-        - guide
-        - hmrc_manual
-        - hmrc_manual_section
-        - html_publication
-        - manual
-        - manual_section
-        - policy_paper
-        - regulation
-        - statutory_guidance
-        - travel_advice
-
-    - id: contacts
-      document_types:
-        - contact
-
-    - id: transactions
-      description: To provide specific information and tools that enables the user to do a thing, based on information they provide during the transaction.
-      document_types:
-        - calculator
-        - completed_transaction
-        - form
-        - licence
-        - local_transaction
-        - place
-        - simple_smart_answer
-        - smart_answer
-        - transaction
-
-    - id: reports
-      description: To share in detail the outcome of investigations, research and changes in regulation (government and independent bodies).
-      document_types:
-        - aaib_report
-        - consultation_outcome
-        - impact_assessment
-        - independent_report
-        - maib_report
-        - raib_report
-        - research
-        - service_standard_report
-
-    - id: decisions
-      description: To share decisions and/or reports made by government on a specific thing.
-      document_types:
-        - asylum_support_decision
-        - decision
-        - dfid_research_output
-        - employment_appeal_tribunal_decision
-        - employment_tribunal_decision
-        - government_response
-        - international_treaty
-        - tax_tribunal_decision
-        - utaac_decision
-
-    - id: engagement-activities
-      description: To enable bodies and people to comment on government policy and provide evidence.
-      document_types:
-        - closed_consultation
-        - cma_case
-        - consultation
-        - notice
-        - open_consultation
-
-    - id: data
-      description: To provide data that enables people to hold government to account (both raw data and data with analysis).
-      document_types:
-        - foi_release
-        - national_statistics
-        - official_statistics
-        - statistical_data_set
-        - statistics
-        - transparency
-
-    - id: organising-entities
-      description: Things that exist in the real world
-      document_types:
-        - working_group
-        - organisation
-        - person
-        - worldwide_organisation
-        - world_location
-        - topical_event
-        - field_of_operation
-        - ministerial_role
-
-    - id: navigation
-      description: Pages that enable users to get to content pages
-      document_types:
-        # "Tags"
-        - document_collection
-        - mainstream_browse_page
-        - policy
-        - policy_area
-        - taxon
-        - topic
-
-        # Hardcoded pages to let users navigate
-        - finder
-        - homepage
-        - search
-        - travel_advice_index
-
-    - id: grants-and-funding
-      document_types:
-        - countryside_stewardship_grant
-        - esi_fund
-        - international_development_fund
-        - business_finance_support_scheme
-
-    - id: corporate-info
-      document_types:
-        - about
-        - about_our_services
-        - access_and_opening
-        - complaints_procedure
-        - corporate_report
-        - equality_and_diversity
-        - help_page
-        - media_enquiries
-        - membership
-        - our_energy_use
-        - our_governance
-        - personal_information_charter
-        - petitions_and_campaigns
-        - procurement
-        - publication_scheme
-        - recruitment
-        - services_and_information
-        - social_media_use
-        - terms_of_reference
-        - welsh_language_scheme
-
-    - id: service-manual
-      document_types:
-        - service_manual_homepage
-        - service_manual_service_toolkit
-        - service_manual_service_standard
-        - service_manual_guide
-        - service_manual_topic
-
 user_journey_document_supertype:
   name: "User journey"
   description: "Used to distinguish pages used mainly for navigation (finding) from content pages (thing)"
@@ -224,8 +12,6 @@ user_journey_document_supertype:
         - license_finder
         - mainstream_browse_page
         - organisation
-        - policy
-        - policy_area
         - search
         - service_manual_homepage
         - service_manual_topic
@@ -234,23 +20,6 @@ user_journey_document_supertype:
         - topic
         - topical_event
 
-search_user_need_document_supertype:
-  name: "Search user need"
-  description: "Used to group documents based on user need, core for mainstream users and government for specialist users in search results"
-  default: government
-  items:
-    - id: core
-      document_types:
-        - answer
-        - guide
-        - local_transaction
-        - place
-        - simple_smart_answer
-        - smart_answer
-        - transaction
-        - travel_advice
-        - travel_advice_index
-
 email_document_supertype:
   name: "Email document type"
   description: "High level group for email subscriptions use to identify publications and announcement"
@@ -392,6 +161,7 @@ content_purpose_subgroup:
         - drug_safety_update
     - id: news
       document_types:
+        - case_study
         - news_article
         - news_story
         - press_release
@@ -441,7 +211,6 @@ content_purpose_subgroup:
         - manual_section
         - guidance
         - map
-        - contact
         - calendar
         - statutory_guidance
         - notice
@@ -449,6 +218,7 @@ content_purpose_subgroup:
         - travel_advice
         - promotional
         - hmrc_manual
+        - standard
     - id: business_support
       document_types:
         - international_development_fund
@@ -458,7 +228,6 @@ content_purpose_subgroup:
     - id: policy
       document_types:
         - impact_assessment
-        - case_study
         - policy_paper
     - id: consultations
       document_types:
@@ -521,6 +290,7 @@ content_purpose_supergroup:
         - correspondence
         - speech
         - government_response
+        - case_study
     - id: services
       document_types:
         - completed_transaction
@@ -543,7 +313,6 @@ content_purpose_supergroup:
         - manual_section
         - guidance
         - map
-        - contact
         - calendar
         - statutory_guidance
         - notice
@@ -556,10 +325,10 @@ content_purpose_supergroup:
         - business_finance_support_scheme
         - statutory_instrument
         - hmrc_manual
+        - standard
     - id: policy_and_engagement
       document_types:
         - impact_assessment
-        - case_study
         - policy_paper
         - open_consultation
         - closed_consultation
@@ -584,7 +353,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 = "1.0.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: 1.0.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2021-05-27 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.1.6
 signing_key: 
 specification_version: 4
 summary: Gem to share document type groupings