govuk_document_types 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c69050edab6c791a73b7879cb0202e5a82dddeff
-  data.tar.gz: 8b2b21f40873ff15eed3ea8004c6e1210130250c
+  metadata.gz: 13692a98e376dd7f97c8e0e2f29c1243a42a80b6
+  data.tar.gz: cff39162f651255bd4355e8f22e198887ee87c09
 SHA512:
-  metadata.gz: f7049a04a1e395d4409b079b28e8ef0706454847dcf1dbfda59370b9d052d8875cb54342d21bdbaa7d46ce167a91fdf6b024fdc58590c0446b9562c8638ccb0b
-  data.tar.gz: c8756847388dac2fa7a373aee0bae55df34cf71cb3381c0f613699da247e0128066d29b9d95427c8b6ec124071ac8fac4a84c435692aace7de95600314a5cb83
+  metadata.gz: 6655ecf82588d51a485534a304fcb0fc73c260c627d4d5201ff21c398e4f59fd1ef96db3703820117ad543d573728ff7765b8cf1a993c0ebd101e48adf0b5163
+  data.tar.gz: 07b75f95bf395b06395dab4fd4efb447d71f24de39d753b924e736296496cabd87a448f703d841c2f396bf4564a47bd48f387c296964a126d4a590d60108adba

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.2.0
+
+* Replace `user_need_document_supertype` by `content_purpose_document_supertype`
+* Updates to `content_purpose_document_supertype`
+
 # 0.1.11
 
 * Add travel_advice_index document type to search_user_need_document_supertype

data/README.md

@@ -8,6 +8,10 @@ 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**.
 
+## 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.
+
 ## How to add a supertype
 
 1. Add it to [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version
@@ -33,6 +37,7 @@ bundle exec rake
 [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
 

data/data/supertypes.yml

@@ -17,7 +17,6 @@ navigation_document_supertype:
         - manual
         - map
         - place
-        - programme
         - promotional
         - regulation
         - simple_smart_answer
@@ -26,45 +25,48 @@ navigation_document_supertype:
         - transaction
         - travel_advice
 
-user_need_document_supertype:
-  name: "User need"
+content_purpose_document_supertype:
+  name: "Content purpose"
   description: "As defined by the Frontend & Navigation team in Q3-2017 - https://gov-uk.atlassian.net/wiki/spaces/GFED/pages/187564388/Grouping+document+types+by+need"
   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
-        - press_release
         - staff_update
         - statistics_announcement
         - vehicle_recalls_and_faults_alert
 
-    - id: news-promotions
+    - id: news
+      description: To communicate what government is doing (non-urgent)
       document_types:
-        - authored_article
-        - campaign
         - case_study
+        - correspondence # Also used for other things
         - news_article
         - news_story
+        - press_release
         - world_location_news_article
         - world_news_story
 
-    - id: marketing
+    - id: resources
       document_types:
+        - map
         - promotional
-        - coming_soon
 
-    - id: speeches
+    - 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
@@ -76,6 +78,8 @@ user_need_document_supertype:
         - html_publication
         - manual
         - manual_section
+        - policy_paper
+        - regulation
         - statutory_guidance
         - travel_advice
 
@@ -84,10 +88,12 @@ user_need_document_supertype:
         - 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
@@ -95,20 +101,19 @@ user_need_document_supertype:
         - 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
-        - financial_release
         - impact_assessment
         - independent_report
         - maib_report
-        - procurement
         - raib_report
-        - regulation
         - 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
@@ -121,26 +126,26 @@ user_need_document_supertype:
         - 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
-        - licence
         - 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:
-        - correspondence
         - foi_release
         - national_statistics
-        - need
         - official_statistics
         - statistical_data_set
         - statistics
         - transparency
 
     - id: organising-entities
+      description: Things that exist in the real world
       document_types:
         - working_group
         - organisation
@@ -148,33 +153,33 @@ user_need_document_supertype:
         - worldwide_organisation
         - world_location
         - topical_event
-        - policy_area
         - field_of_operation
         - ministerial_role
-        - topical_event_about_page
-
-    - id: support
-      document_types:
-        - countryside_stewardship_grant
-        - esi_fund
-        - international_development_fund
 
     - id: navigation
+      description: Pages that enable users to get to content pages
       document_types:
-        - finder_email_signup
-        - homepage
+        # "Tags"
+        - document_collection
         - mainstream_browse_page
-        - search
-        - take_part
+        - policy
+        - policy_area
         - taxon
         - topic
 
-    - id: finder
-      document_types:
-        - document_collection
+        # 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
@@ -189,12 +194,14 @@ user_need_document_supertype:
         - 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
-        - petitions_and_campaigns
 
     - id: service-manual
       document_types:

data/lib/govuk_document_types/version.rb

@@ -1,3 +1,3 @@
 module GovukDocumentTypes
-  VERSION = "0.1.11".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_document_types
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake