Fix search 'autocomplete' behaviour #236
Merged
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
lfdebrux
changed the title
Search results will no longer disappear and reappear again as a user is typing a word in. Removing the stemmer from the search index pipeline stops the search term from being truncated when a search is made. This fixes #222. Description of issue -------------------- I noticed that certain searches have surprising behaviour as the search term was typed in; for instance, when searching for "documentation": - searching "d" gives 5 results - searching "do" gives 0 results - searching "doc", "docu", "docum", "docume", "documen", "document" gives 1 result - searching "documenta", "documentat", "documentati", "documentatio" gives 0 results - searching "documentation" gives 1 result This is surprising because search is incremental, meaning the results change a lot while typing a word. It is could also be confusing when searching for a particular long word; for instance, if someone was searching for references to "documentation" and there are a lot of results for "document" but none for "documenta" they might think that means they are no uses of the word "documentation" in the website. Fix --- This problem had already been identified in the Design System website, see commit alphagov/govuk-design-system@531d3c3. Thanks @36degrees for flagging that this fix existed. The fix is to remove the stemmer from the lunr pipeline. This is easily done with the fork of [middleman-search] that the tech-docs-gem uses. This commit also adds a simple test to prevent future changes breaking this functionality. [middleman-search]: https://github.com/alphagov/middleman-search
lfdebrux
force-pushed
the
ldeb-fix-222
branch
from
07a3f65
to
1bd57e6
Compare
Merged
kr8n3r
added a commit
to alphagov/paas-tech-docs
that referenced
this pull request
Sep 15, 2021
Main one is govuk-tech-docs gem v2.4.3 which brings - [#236: Fix search 'autocomplete' behaviour](alphagov/tech-docs-gem#236) - [#203: Update vendored javascripts](alphagov/tech-docs-gem#203)
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.
Search results will no longer disappear and reappear again as a user is typing a word in.
Fixes #222.
Fix
This problem had already been identified in the Design System website, see commit alphagov/govuk-design-system@531d3c3. Thanks @36degrees for flagging that this fix existed.
The fix is to remove the stemmer from the lunr pipeline. This is easily done with the fork of middleman-search that the tech-docs-gem uses.
This commit also adds a simple test to prevent future changes breaking this functionality.