| status | implementation | status_last_reviewed |
|---|---|---|
accepted |
done |
2024-03-04 |
Create an external_content document type to represent pages that aren't part
of GOV.UK but are relavent to our users.
Not everything government related is on GOV.UK.
Search admin stores "External links", which can be returned for certain search terms.
For example:
- searches for "mp" can return the parliament.uk page http://www.parliament.uk/mps-lords-and-offices/mps/
- searches for "fit for work" can return http://fitforwork.org/
- searches for council names can return the council website
We are currently changing search indexing to source all its content from the publishing API, but external links have never been part of the publishing API.
Create an external_content document type so we can store these links in the publishing API.
Create an external_content schema.
The schema MUST store in the details hash:
hidden_search_terms- a set of search keywords/phrases that should route users to the page. This field has already been added for smart answers.url- a URL for the external resource
The schema MAY store information about change history.
The standard fields title and description MUST be set.
In accordance with RFC 43 The base_path, rendering_app, redirects and routes MUST NOT be set.
- External content can be defined centrally and reused across the platform
- The standard
linkshash can be used to refer to external content. The platform does not make any distinction between internal and external content.
This means that external_related_links in the details hash is technically redundant, and external links could be managed independently of the publishing workflow (for example, through content tagger).
This RFC acknowledges but does not address this duplication. The intention is only to move the search admin concept of an external link into the publishing API.