Remove a change note in Whitehall
Change notes are called editorial remarks in Whitehall. An Edition can
have multiple editorial remarks and they are visible only in Whitehall
Admin. However, an Edition in the Publishing API can only have one
change_note, which is public-facing. The Publishing API creates a list of all the change notes
from all versions of the edition and presents them to the Content Store.
You can read more about this in the Publishing API docs.
Remove a change note
You need to determine whether the request is referring to an
editorial_remark in Whitehall Admin, or to a public-facing
change_note in Publishing API.
- Obtain the content ID of the document on which the change note was created.
This document will contain multiple editions. You need to extract the
editorial_remarkfrom these editions.
- Create a data migration in Whitehall docs here
- In the data migration, search for the document by the content ID and
editorial_remarkthat contains the text you are looking to delete.
- If such an editorial remark is present, then destroy the
editorial_remarkand check that it is no longer displayed.
- Search for the document by content ID in the Publishing API:
Document.where(content_id: "your-content-id")and extract the
change_note. If the document is associated with multiple editions, you should search through all of them for the text of the change note:
document.editions.map(&:change_note). An example PR can be found here
- Find the change note containing the text you are looking to delete and destroy it.
- Check hat the change note is no longer displayed.
- If the change note was indicating a major change, then it will be propagated to an Edition in Publishing API. You can search for that edition using the content ID (Edition IDs will not coincide between whitehall and Publishing API). You can also do a free-text search for the change note.
- Delete the change note and re-send the edition to the Content Store to be updated.
- You will also have to delete the change history as this does not get regenerated automatically. This change also has to represented downstream to the Content Store so you should combine it with the previous step. An example PR can be found here