Truncate search results

[dwelsch-esi]

Overview

Audience: All

Type: All

The Search function does not truncate results. For example, the "Puppet" entry
when searching "getting started" displays the page's entire 900 words.

Configure the Search to truncate results after 100 characters or so. Displaying
the entire page text of each result hinders users' ability to find their result.

Context

This issue tracks recommended changes resulting from an analysis of the Knative
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses under 0015-knative.

Possible Implementation

Related material in the current doc:

• https://github.com/knative/
• https://github.com/knative/docs/blob/main/mkdocs.yml

Suggested changes:

Search result entries are too long. The most straightforward solution is
probably to cut off each search result after a number of characters, say 100 or
so.

This change probably has to be implemented in the mkdocs configuration. I'd
start by looking at the [mkdocs config file].