Improve installation questions #222
Comments
ethanmills
pushed a commit
to ethanmills/tech-docs-template
that referenced
this issue
Feb 17, 2023
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 alphagov#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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What should change
During the TDT install process, some of the questions users are asked are not written in a user-focused way. For example: 'What is the canonical hostname of your application?'. It'd be good to rewrite the questions so they're in plainer language.
User need
Users may fail to understand the questions and be blocked from installing the TDT, because they're not sure how to answer.
The text was updated successfully, but these errors were encountered: