ys2843 opened a new issue #18234:
URL: https://github.com/apache/incubator-mxnet/issues/18234


   ## Description
   MXNet website hosts not only rich and comprehensive documentations, but also 
many useful resources including tutorials, installation guide, APIs and blogs 
etc. The majority of our target users are those who are curious about MXNet and 
want to explore, their primary target will mostly be tutorials, FAQs, blog 
posts and other solution contents. But the current version of MXNet website 
does not provide anything for them to find the materials they need. This could 
prevent users from further exploring and staying interested in MXNet. And for 
power users who will come to API docs directly, it will greatly improve their 
experience if a global search feature is available everywhere not only within 
API document.
   
   ## Proposed Solution
   So as to improve user experience of MXNet website and better convey our 
product values to end users, a global search feature should be implemented, on 
the top Nav bar accessible to users across all main information pages, with the 
capability of searching information across all site and always provide the 
valid and fresh results.
   It is a lot more cost and time efficient to integrate a stable and trust 
worthy 3rd party search service to MXNet website than to start from scratch. 
[DocSearch by Algolia](https://docsearch.algolia.com/) is one of the site 
search solutions that is technical documentation oriented and widely adopted by 
many professional documentation websites including 
[PyTorch](https://pytorch.org/), 
[TypeScript](https://www.typescriptlang.org/index.html ), 
[React](https://reactjs.org/), [Bootstrap](https://getbootstrap.com/), 
[Scala](https://www.scala-lang.org/) and [GitLab](https://about.gitlab.com/) 
etc. 
   
   ## Deliverable
   A search bar powered by DocSearch on MXNet website, capable of searching 
across all site in any version, located on the right side of main Nav bar with 
a drop down menu attached that contains all available version options.
   
   ## Acceptance Criteria
   * Search bar accessible across all information web pages
   * Providing real time searching, search as you type, always return fresh and 
valid result
   * The scope of search should be the whole website and all versions
   * Simple and consistent front end user interface for searching and result 
displaying
   
   ## Reference
   1. [Detailed quip project proposal - 
internal](https://quip-amazon.com/3bsRAMn6uvx0/MXNet-Website-20-Global-Search)
   2. [DocSearch website](https://docsearch.algolia.com/)
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


Reply via email to