Add govspeak support for finder summary #3145
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@kashifatcha is this still being worked on? Do you mind if we mark it as a draft for now (to stop alerts in our team channel)? |
|
@yndajas I have marked it as a draft PR for now |
kashifatcha
force-pushed
the
add-govspeak-support-for-summary-property
branch
from
1f533fe to
c057fca
Compare
Introduce new schema structures for finder summaries. Specialist finder summaries are now converted to GovSpeak. In order to send GovSpeak the schema structure will have to match multiple content type definitions, but other finders such as licence finder will still be sending a string summary. We need to support both.
minhngocd
force-pushed
the
add-govspeak-support-for-summary-property
branch
from
e8c2822 to
d60e101
Compare
ChrisBAshton
approved these changes
Mar 10, 2025
| @@ -288,6 +288,9 @@ | |||
| { | |||
| type: "null", | |||
| }, | |||
| { | |||
| "$ref": "#/definitions/multiple_content_types", | |||
There was a problem hiding this comment.
I'd suggest moving this into its own commit, and then doing the 'regenerate schemas' bit in a second commit. Makes it easier to see what you've changed vs the auto-generated changes that come later.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
The schemas in Specialist Publisher have a summary property which can (and often does) contain HTML. This is exposed to the publisher on the “edit metadata” form (example).
The property should be stored in the schema as GovSpeak, and rendered in the publisher <textarea> as GovSpeak, but presented downstream as HTML.
Why
Publishers shouldn’t be expected to have to write HTML. And if they do use GovSpeak, the developer has to manually convert this to HTML before it can be processed.
https://trello.com/c/FHjlxPUv/3410-add-govspeak-support-for-summary-property-in-specialist-publisher-schemas
This application is owned by the publishing platform team. Please let us know in #govuk-publishing-platform when you raise any PRs.
Follow these steps if you are doing a Rails upgrade.