aaronmarkham opened a new pull request #13921: Version switching user experience improvements URL: https://github.com/apache/incubator-mxnet/pull/13921 ## Description ## This PR fixes some usability problems with the version selector. You tend to lose your place when you use the search feature or when browsing the APIs looking for stuff. If you switch versions, you don't always end up where you were or get redirected to the home page. ## Preview for Search When you search for something on the website in an older version, don't find it, then switch to a newer version, you are redirected to the root of the website. For example: 1. Search for "taco": http://mxnet.incubator.apache.org/versions/1.0.0/search.html?q=taco&check_keywords=yes&area=default No 🌮 ! What if master has 🌮 ? 2. Use the versions dropdown and change to master. You lost your search! 😠and still no 🌮 . Now try to search for 🌮 on the preview: 1. http://34.201.8.176/versions/1.3.1/search.html?q=taco No 🌮 . 2. Change to master. Still no 🌮 but 🌤 you didn't get bounced to the home page. ## Preview for Anchors It seems to work now when the page is loaded anew. However, I noticed that using in-page anchors the page didn't provide a new `window.location.hash` to the function in `docversion.js` that updates the version dropdown's links, so the when switching versions you don't load the last anchor you were on. 1. Go look at ndarray docs: http://34.201.8.176/versions/1.3.1/api/python/ndarray/ndarray.html 2. Scroll down and click the link for `ndarray.shape`. 3. You jump down to the docs for shape. But you decide you don't like it, and you want to know if master has more features. Your current location is now http://34.201.8.176/versions/1.3.1/api/python/ndarray/ndarray.html#mxnet.ndarray.NDArray.shape 4. Use the version dropdown to change to Master. 5. Witness 👀 that you are now on: http://34.201.8.176/versions/master/api/python/ndarray/ndarray.html#mxnet.ndarray.NDArray.shape If you try this flow in production you see that it is kind of broken. ## Comments The redirects update and overview of intentions and test links are on the wiki: https://cwiki.apache.org/confluence/display/MXNET/Redirects+on+the+Website The search feature on the website is buggy. Today it shows results in an old version that shouldn't be there. For example "allreduce" shouldn't appear <v1.2.1, but it does today. I'm not trying to fix Sphinx's search in this PR.
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
