[jira] [Created] (MXNET-996) User searches for document across APIs and versions

["Aaron Markham (JIRA)" <ji...@apache.org>]

Aaron Markham created MXNET-996:
-----------------------------------

             Summary: User searches for document across APIs and versions
                 Key: MXNET-996
                 URL: https://issues.apache.org/jira/browse/MXNET-996
             Project: Apache MXNet
          Issue Type: Story
            Reporter: Aaron Markham


A typical use case for a user is to search for a bit of functionality on Google. Often times this will bring them to an API that is outdated.
 * It should be clear to the user that they can find alternative versions of the API - either version-wise or a different language API.

 

Another use case is searching on the website itself.
 * All of the language bindings' API docs should be searchable through the site's search. Today they are not. Scala API docs are just one example.
 * When you search from within a version, if you don't find what you're looking for you should be prompted that it could exist in another version.
 * Even better, clearly identified alternatives are presented. For example, searching for "allreduce":
 ** Your search did not match any documents. Searching other versions produced these results:
 *** v1.3.0 - allreduce ....
 *** master - allreduce ....
 * Currently you get no results from other versions which is "by design" but quite limiting when you're really trying hard to find a feature.

 



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@mxnet.apache.org
For additional commands, e-mail: issues-help@mxnet.apache.org