Merge pull request #10976 from alphagov/change-workflow-updates

Change [document type - news articles] workflow updates [WHIT-2812]

Author: patrickpatrickpatrick

app/components/admin/editions/document_type_change_summary.html.erb

@@ -6,18 +6,18 @@
 <% else %>
   <h3 class="govuk-heading-m">Document fields</h3>
   <p class="govuk-body">
-    All document fields will be carried over and no additional document fields will need to be populated.
+    All content in the document fields will be carried over. You will not have to add your content again.
   </p>
 <% end %>
 
 <% if lost_association_items.any? || new_association_items.any? %>
   <%= render "govuk_publishing_components/components/summary_list", {
     title: "Associations",
-    items: lost_association_items + new_association_items,
+    items: lost_association_items + new_association_items + common_association_items,
   } %>
 <% else %>
   <h3 class="govuk-heading-m">Associations</h3>
   <p class="govuk-body">
-    All associations will be carried over and no additional associations will need to be populated.
+    All associations will be carried over. You will not have to fill in the associations again.
   </p>
 <% end %>

app/components/admin/editions/document_type_change_summary.rb

@@ -2,12 +2,16 @@ class Admin::Editions::DocumentTypeChangeSummary < ViewComponent::Base
   attr_reader :lost_property_items,
               :new_property_items,
               :lost_association_items,
-              :new_association_items
+              :new_association_items,
+              :common_association_items
 
   def initialize(edition:, old_type:, new_type:)
     @edition = edition
     @old_type = old_type
     @new_type = new_type
+    @association_to_label = {
+      "ministerial_role_appointments" => "Ministers",
+    }
 
     compute_diffs
   end
@@ -19,34 +23,36 @@ def compute_diffs
     added_prop_keys   = @new_type.properties.keys - @old_type.properties.keys # will need populating
     removed_assoc_keys = @old_type.associations.map { |a| a["key"] } - @new_type.associations.map { |a| a["key"] }
     added_assoc_keys   = @new_type.associations.map { |a| a["key"] } - @old_type.associations.map { |a| a["key"] }
+    common_assoc_keys = @new_type.associations.map { |a| a["key"] } & @old_type.associations.map { |a| a["key"] }
 
     @lost_property_items = removed_prop_keys.map do |key|
       schema = @old_type.properties[key]
       {
         field: schema["title"] || key.humanize,
-        value: "Will be LOST - this field exists on “#{@old_type.label}” but not on “#{@new_type.label}”.",
+        value: "Will be <strong>deleted</strong>. A ‘#{@new_type.label}’ does not have a ‘#{schema['title'] || key.humanize}’ field.".html_safe,
       }
     end
 
     @new_property_items = added_prop_keys.map do |key|
       schema = @new_type.properties[key]
       {
         field: schema["title"] || key.humanize,
-        value: "Will need POPULATING - this field exists on “#{@new_type.label}” but not on “#{@old_type.label}”. It will be blank after the change.",
+        value: "Will need to be <strong>added</strong>. A ‘#{@new_type.label}’ has a ‘#{schema['title'] || key.humanize}’ field. This field will be blank after the change.".html_safe,
       }
     end
 
-    @lost_association_items = removed_assoc_keys.map do |key|
-      {
-        field: key.humanize,
-        value: "Will be LOST - this association exists on “#{@old_type.label}” but not on “#{@new_type.label}”.",
-      }
-    end
+    @lost_association_items = build_association_items(removed_assoc_keys, proc { |field| "Will be <strong>deleted</strong>. A ‘#{@new_type.label}’ does not have a ‘#{field}’ association.".html_safe })
+    @new_association_items = build_association_items(added_assoc_keys, proc { |field| "Will need to be <strong>added</strong>. A ‘#{@new_type.label}’ has a ‘#{field}’ association. This field will be blank after the change.".html_safe })
+    @common_association_items = build_association_items(common_assoc_keys, proc { "These associations will be carried over, you will not have to fill them in again." })
+  end
+
+  def build_association_items(items, value)
+    items.map do |key|
+      field = @association_to_label[key] || key.humanize
 
-    @new_association_items = added_assoc_keys.map do |key|
       {
-        field: key.humanize,
-        value: "Will need POPULATING - this association exists on “#{@new_type.label}” but not on “#{@old_type.label}”. It will be blank after the change",
+        field:,
+        value: value.call(field),
       }
     end
   end

app/models/configurable_document_types/government_response.json

@@ -1,7 +1,7 @@
 {
   "key": "government_response",
   "title": "Government response",
-  "description": "Government statements in response to media coverage, such as rebuttals and ‘myth busters’. Do not use for: statements to Parliament. Use the “Speech” format for those.",
+  "description": "Government statements in response to media coverage, such as rebuttals and ‘myth busters’. Do not use for: statements to Parliament. Use the ‘Speech’ format for those.",
   "forms": {
     "documents": {
       "fields": {

app/models/configurable_document_types/press_release.json

@@ -1,7 +1,7 @@
 {
   "key": "press_release",
   "title": "Press release",
-  "description": "Unedited press releases as sent to the media, and official statements from the organisation or a minister. Do not use for: statements to Parliament. Use the “Speech” format for those.",
+  "description": "Unedited press releases as sent to the media, and official statements from the organisation or a minister. Do not use for: statements to Parliament. Use the ‘Speech’ format for those.",
   "forms": {
     "documents": {
       "fields": {

app/models/configurable_document_types/world_news_story.json

@@ -1,7 +1,7 @@
 {
   "key": "world_news_story",
   "title": "World news story",
-  "description": "Announcements specific to one or more world location. Don’t duplicate news published by another department.",
+  "description": "Announcements specific to one or more world location. Do not duplicate news published by another department.",
     "forms": {
     "documents": {
       "fields": {

app/models/publication_type.rb

@@ -8,20 +8,20 @@ class PublicationType
   FORMAT_ADVICE = {
     1 => "<p>A policy paper explains the government’s position on something. It doesn’t include instructions on how to carry out a task, only the policy itself and how it’ll be implemented.</p><p>Read the <a href=\"https://www.gov.uk/guidance/content-design/content-types#policy-paper\" target=\"_blank\" class=\"govuk-link\">policy papers guidance</a> in full.</p>",
     2 => "<p>Cost-benefit analyses and other assessments of the impact of proposed initiatives, or changes to regulations or legislation.</p>",
-    3 => "<p>Non-statutory guidance publications. Includes: manuals, handbooks and other documents that offer advice.</p><p>Do not use for: statutory guidance (use the “statutory guidance” publication type) or guidance about completing a form (attach to same publication as the form itself).</p>",
-    4 => "<p>Pro-forma or form documents that need to be completed by the user. Can include guidance on how to fill in forms (ie no need to create a separate “guidance” publication for form instructions).</p>",
+    3 => "<p>Non-statutory guidance publications. Includes: manuals, handbooks and other documents that offer advice.</p><p>Do not use for: statutory guidance (use the ‘statutory guidance’ publication type) or guidance about completing a form (attach to same publication as the form itself).</p>",
+    4 => "<p>Pro-forma or form documents that need to be completed by the user. Can include guidance on how to fill in forms (ie no need to create a separate ‘guidance’ publication for form instructions).</p>",
     5 => "<p>Statistics governed by the UK Statistics Authority and produced by members of the Government Statistical Service.</p>",
     6 => "<p>Research and evaluation papers. Can be conducted by government, commissioned by government or independent of government.</p>",
-    7 => "<p>Publications about what an organisation does (eg business plans, annual reports, accounts), or any plans that affect the organisation (eg structural reform plans, efficiency reviews). Corporate reports are shown automatically on the organisation’s “What we do” page.</p>",
-    8 => "<p>Ministerial or departmental responses (eg to campaign letters), announcements, or statements;regularly issued circulars or bulletins (eg fire service circulars), official correspondence to professionals (eg “Dear chief planning officer” letters);letters to individuals or organisations that are published to share with a wider audience than their original recipient;online versions of e-bulletins or newsletters.</p><p>Do not use for: minutes, agendas or other meeting papers. Attach them to relevant “policy detail”, “team” or “our governance” pages instead.</p>",
+    7 => "<p>Publications about what an organisation does (eg business plans, annual reports, accounts), or any plans that affect the organisation (eg structural reform plans, efficiency reviews). Corporate reports are shown automatically on the organisation’s ‘What we do’ page.</p>",
+    8 => "<p>Ministerial or departmental responses (eg to campaign letters), announcements, or statements;regularly issued circulars or bulletins (eg fire service circulars), official correspondence to professionals (eg ‘Dear chief planning officer‘ letters);letters to individuals or organisations that are published to share with a wider audience than their original recipient;online versions of e-bulletins or newsletters.</p><p>Do not use for: minutes, agendas or other meeting papers. Attach them to relevant ‘policy detail’, ’team’ or ‘our governance’ pages instead.</p>",
     10 => "<p>Information made available about departmental operations with the intent of making government more transparent.Includes organisation charts, staff survey results, departmental spending, salaries, contracts, meetings with ministers, etc.</p><p>Do not use for: FOI responses.</p>",
     12 => "<p>Responses to Freedom of Information requests. Ensure the title describes specifically what the request is about.</p>",
     13 => "<p>Leaflets, posters, fact sheets and marketing collateral.</p>",
     14 => "<p>Reviews, inquiries and other reports commissioned from or conducted by independent (ie non-governmental) bodies for consideration by the government.</p>",
     15 => "<p>Official Statistics that have been produced in accordance with the Code of Practice for Official Statistics, which is indicated using the Accredited Official Statistics quality mark.</p>",
     17 => "<p>Drawn maps and geographical data.</p>",
     18 => "<p>Treaties and memoranda of understanding between the UK and other nations.</p>",
-    19 => "<p>Guidance which relevant users are legally obliged to follow. (For non-statutory guidance publications, use the “guidance” sub-type).</p>",
+    19 => "<p>Guidance which relevant users are legally obliged to follow. (For non-statutory guidance publications, use the ‘guidance’ sub-type).</p>",
     20 => "<p>Permit and licence applications published temporarily for public awareness.</p>",
     21 => "<p>Formal decisions by tribunals, regulators or adjudicators (including courts and Secretaries of State).</p>",
     22 => "<p>Regulations imposed by an independent regulatory authority only.</p><p>Do not use for: statutory guidance.</p>",

app/views/admin/editions/edit.html.erb

@@ -37,7 +37,11 @@
         items: secondary_navigation_tabs_items(@edition, request.path),
       } if @edition.editable? %>
 
-      <%= govspeak_to_html("^This is a read-only view of the current (#{@edition.state}) edition. To edit, please return to the summary page and choose \"Create new edition\".^") unless @edition.editable? %>
+      <% unless @edition.editable? %>
+        <%= render "govuk_publishing_components/components/inset_text", {} do %>
+          This is a read-only view of the current (<%= @edition.state %>) edition. To edit, please return to the summary page and choose ‘Create new edition’.
+        <% end %>
+      <% end %>
 
       <%= render "form", edition: @edition %>
     </div>

app/views/admin/speeches/_form.html.erb

@@ -1,6 +1,6 @@
 <div class="format-advice">
   <p class="govuk-body"><strong>Use this format for:</strong> Public speeches by ministers or other named spokespeople, ministerial statements to Parliament and bylined articles.</p>
-  <p class="govuk-body">Do not use for: statements <em>not</em> made to Parliament (use the “news article” format for those).</p>
+  <p class="govuk-body">Do not use for: statements <em>not</em> made to Parliament (use the ‘news article’ format for those).</p>
 </div>
 
 <%= standard_edition_form(edition) do |form| %>

app/views/admin/standard_editions/change_type_preview.html.erb

@@ -1,4 +1,4 @@
-<% page_heading = "Preview document type change" %>
+<% page_heading = "Review document type change" %>
 <% content_for :page_title, page_heading %>
 <% content_for :back_link do %>
   <%= render "govuk_publishing_components/components/back_link", {
@@ -11,10 +11,9 @@
     <h1 class="govuk-heading-l"><%= page_heading %></h1>
 
     <p class="govuk-body">
-      You are about to change the document type of “<%= @edition.title %>”
+      You're about to change the document type of ‘<%= @edition.title %>’
       from <strong><%= @old_type.label %></strong>
-      to <strong><%= @new_type.label %></strong>. A summary of the changes is
-      shown below. Please review these carefully before proceeding.
+      to <strong><%= @new_type.label %></strong>. A summary of what this change means is shown below. Please review carefully before confirming the change.
     </p>
 
     <%= render(

app/views/admin/statistical_data_sets/_form.html.erb

@@ -1,5 +1,5 @@
 <div class="format-advice">
-  <p class="govuk-body"><strong>Use this format for:</strong> Frequently updated (“live”) statistical data files.</p>
+  <p class="govuk-body"><strong>Use this format for:</strong> Frequently updated (‘live’) statistical data files.</p>
   <p class="govuk-body">Do not use for: less frequently updated (eg quarterly) data. Use a publication (subtype: statistics) instead.</p>
 </div>