elastic / elastic/docs

Add search to docs 404 page

Open
#1,839 0 comments 0 reactions 0 assignees View on GitHub
defer design enhancement
Dominant language
Ruby
Stars
265
Forks
347
Avg merge
3d 15h
Merged PRs (30d)
2

Description

No matter how good our docs are, there will always be users hitting 404s. In addition to the redirect strategy being discussed in https://github.com/elastic/docs/issues/1820, can we add search to our 404 page?

As an example, [here's](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-keys.html) a documentation 404. Anyone who hits that page will see this:


Screen Shot 2020-05-13 at 2 14 58 PM

It's fun, but it's not helpful. What would be helpful, is if the 404 page was able to display relevant search results based on the bad URL and provide a search box for users to craft their own searches. Based on the URL in this example, the 404 page might include something like this:


Screen Shot 2020-05-13 at 2 32 09 PM

A quick google search shows that smart 404 pages like this are actually a feature of Swiftype: **[Building a smart 404 page with Swiftype](https://swiftype.com/documentation/site-search/tutorials/smart_404_page)**. 🐶🥫

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.