From 825d893642fa6bc103b36273307e8c070ed087ac Mon Sep 17 00:00:00 2001 From: Richard Towers Date: Fri, 21 Jun 2024 19:04:39 +0100 Subject: [PATCH] Move whitehall scheduled publishing docs from alerts There's no longer an alert for this, but the docs still seem useful. Moving them to the Publishing section so they're not lost, and making some slight changes to wording / updating a link. --- config/tech-docs.yml | 1 + source/manual/help-with-publishing-content.html.md | 2 +- source/manual/on-call.html.md | 4 ++-- .../whitehall-scheduled-publishing.html.md.erb | 12 ++++++------ 4 files changed, 10 insertions(+), 9 deletions(-) rename source/manual/{alerts => }/whitehall-scheduled-publishing.html.md.erb (81%) diff --git a/config/tech-docs.yml b/config/tech-docs.yml index 63ac2552f4..ef1388defb 100644 --- a/config/tech-docs.yml +++ b/config/tech-docs.yml @@ -148,6 +148,7 @@ redirects: /manual/alerts/elasticsearch-cluster-health.html: /manual/elasticsearch-cluster-health.html /manual/alerts/email-alerts.html: /manual/alerts/email-alerts-travel-medical.html /manual/alerts/publisher-unprocessed-fact-check-emails.html: /manual/publisher-unprocessed-fact-check-emails.html + /manual/alerts/whitehall-scheduled-publishing.html: /manual/whitehall-scheduled-publishing.html /manual/archiving-and-redirecting-content.html: /manual/redirect-routes.html /manual/bouncer.html: /manual/transition-architecture.html /manual/bulk-email.html: /apps/email-alert-api/bulk-email.html diff --git a/source/manual/help-with-publishing-content.html.md b/source/manual/help-with-publishing-content.html.md index 2a9937db1f..3515f58a64 100644 --- a/source/manual/help-with-publishing-content.html.md +++ b/source/manual/help-with-publishing-content.html.md @@ -39,7 +39,7 @@ necessary to help them to ensure it goes out as smoothly as possible. Safety Alerts go out correctly. Although an alert won't be triggered for other kinds of documents, the [guidance will still apply](alerts/email-alerts-travel-medical.html). -- If [a scheduled publication hasn't gone live](alerts/whitehall-scheduled-publishing.html), +- If [a scheduled publication hasn't gone live](whitehall-scheduled-publishing.html), start here: [if documents aren't live after being published][live]. If it looks as though the content was never published from Whitehall, there is a Rake task available which will publish overdue diff --git a/source/manual/on-call.html.md b/source/manual/on-call.html.md index 902832d5ee..bc3dc3dc3a 100644 --- a/source/manual/on-call.html.md +++ b/source/manual/on-call.html.md @@ -60,8 +60,8 @@ push notification). There are 2 ways that this might contact you: Any Icinga checks that use `govuk_urgent_priority` will cause PagerDuty to be notified: - [Travel advice emails not going out](/manual/alerts/email-alerts-travel-medical.html) -- [Overdue publications in Whitehall](/manual/alerts/whitehall-scheduled-publishing.html#overdue-publications-in-whitehall) -- [Scheduled publications in Whitehall not queued](/manual/alerts/whitehall-scheduled-publishing.html#scheduled-publications-in-whitehall-not-queued) +- [Overdue publications in Whitehall](/manual/whitehall-scheduled-publishing.html#overdue-publications-in-whitehall) +- [Scheduled publications in Whitehall not queued](/manual/whitehall-scheduled-publishing.html#scheduled-publications-in-whitehall-not-queued) - [High nginx 5xx rate for www-origin on cache machines](/manual/alerts/high-nginx-5xx-rate.html) You can get the most up to date list of these by searching the Puppet repo for [govuk_urgent_priority](https://github.com/alphagov/govuk-puppet/search?q=govuk_urgent_priority). diff --git a/source/manual/alerts/whitehall-scheduled-publishing.html.md.erb b/source/manual/whitehall-scheduled-publishing.html.md.erb similarity index 81% rename from source/manual/alerts/whitehall-scheduled-publishing.html.md.erb rename to source/manual/whitehall-scheduled-publishing.html.md.erb index 47e6e618c2..436f023e00 100644 --- a/source/manual/alerts/whitehall-scheduled-publishing.html.md.erb +++ b/source/manual/whitehall-scheduled-publishing.html.md.erb @@ -3,12 +3,12 @@ owner_slack: "#govuk-whitehall-experience-tech" title: Whitehall scheduled publishing parent: "/manual.html" layout: manual_layout -section: Icinga alerts +section: Publishing --- ## Overdue publications in Whitehall -This alert means that there are scheduled editions which have passed their +Sometimes there may be scheduled editions which have passed their publication due date but haven't been published by the scheduled publishing workers. Scheduled publishing is performed by Sidekiq workers picking up jobs from a scheduled queue. @@ -37,11 +37,11 @@ following: If the above rake tasks aren't working, it could be because the database was recently restored, perhaps due to the data sync. In that case, you can try -running the following Rake task on a `whitehall_backend` machine: +running the following Rake task: <%= RunRakeTask.links("whitehall-admin", "publishing:scheduled:requeue_all_jobs") %> -Due to the overnight [data anonymisation process](https://github.com/alphagov/whitehall/blob/7b5c5a086b89cb62ffba62b152a0a8dcfc10c8e6/script/scrub-database) you may notice +Due to the overnight [data anonymisation process](https://github.com/alphagov/govuk-helm-charts/blob/20a96dd5/charts/db-backup/scripts/whitehall.sql) you may notice that some of the pending documents have one or more edition that is in a `scheduled` state, is `access_limited`, and may have one or more attachments with the filename `redacted.pdf`. @@ -54,8 +54,8 @@ the same documents/editions. ## Scheduled publications in Whitehall not queued -This alert means that the number of editions in the database which are -scheduled to be published in the future is different from the number currently +It is also possible for the number of editions in the database which are +scheduled to be published in the future to be different from the number currently in the queue. Run the `publishing:scheduled:requeue_all_jobs` Rake task to requeue all