New documentation for document-collection emails #4631
Conversation
hannako
force-pushed
the
override_email_notifications
branch
6 times, most recently
from
ecf24d6
to
66e055f
Compare
source/manual/document-collection-emails-a-special-case.html.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Wow, this is a really hard snowflake ❄️ to articulate, but I think you've done a really good job. 🎉
I've added some in-line comments where I think things might be unclear.
I half-remember what went on and what was agreed, so I could fill in some, but not all of of the blanks. However, I think though, no knowledge should be assumed, and these docs should be as hand-holdy as possible because as you know emails in general, and this in particular, are very complex concepts to get your head around.
source/manual/document-collection-emails-a-special-case.html.md
Outdated
Show resolved
Hide resolved
source/manual/document-collection-emails-a-special-case.html.md
Outdated
Show resolved
Hide resolved
|
|
||
| #### How to set a taxonomy topic email override field for previously published pages | ||
|
|
||
| It is not possible to set this field on a previously published page. If a request is made to `2nd line - GOV.UK content` to add this feature to a live page, their documentation aligns with the guidance below: |
There was a problem hiding this comment.
Are you trying to say that the 2nd line - GOV.UK content guidance is the same as the bullet points below?
source/manual/document-collection-emails-a-special-case.html.md
Outdated
Show resolved
Hide resolved
source/manual/document-collection-emails-a-special-case.html.md
Outdated
Show resolved
Hide resolved
source/manual/document-collection-emails-a-special-case.html.md
Outdated
Show resolved
Hide resolved
| #### How to check if a document_collection has previously been published | ||
|
|
||
| 1. Find the document_collection in the whitehall admin UI | ||
| 2. Find the ID. E.g. `12345` for a document_collection at URL `whitehall-admin.publishing.service.gov.uk/government/admin/collections/12345` | ||
| 3. `DocumentCollection.find(12345).document.live?` returns `true` for previously published document_collections. | ||
|
|
||
| #### How to set a taxonomy topic email override field for new pages |
There was a problem hiding this comment.
I believe "finding the document collection id" is a necessary step for both "checking if the document collection has been published" and to "set the taxonomy topic override".
However the why the steps are laid out makes it look you always need to check if a document collection has been published first, but I believe the rake task checks this for you, and raises an exception.
Perhaps have the "How to check if a document_collection has previously been published" steps ask people to run the rake task in "dry run" mode to check for errors rather than spinning up a rails console?
I'd also duplicate the step for finding the document collection id before the instructions for running the rake task.
There was a problem hiding this comment.
Ah think I've not addressed the last sentence here so I won't resolve this comment!
source/manual/document-collection-emails-a-special-case.html.md
Outdated
Show resolved
Hide resolved
source/manual/document-collection-emails-a-special-case.html.md
Outdated
Show resolved
Hide resolved
|
Thanks @leenagupte - Much appreciated! |
hannako
force-pushed
the
override_email_notifications
branch
from
66e055f
to
3bfe3f3
Compare
hannako
force-pushed
the
override_email_notifications
branch
from
3bfe3f3
to
94bea3c
Compare
hannako
force-pushed
the
override_email_notifications
branch
from
94bea3c
to
0f48cb2
Compare
Add documentation to explain the taxonomy_topic_email_override feature present on some document collection pages.