Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Fix version dropdown behavior #12632

Merged
merged 3 commits into from
Sep 22, 2018
Merged

Conversation

aaronmarkham
Copy link
Contributor

@aaronmarkham aaronmarkham commented Sep 21, 2018

Description

This PR fixes the bad behavior of the versions dropdown on the website. It will remember what API document you were viewing when you switch versions. It even remembers which anchor/bookmark you're on.

Preview

You can play with it here: http://34.201.8.176/

This is how it works on the site now. You're in deep on some doc page, and then think, "I wonder if the params are different in the last release...". You click the versions dropdown, select 1.3.0, and then bam, you're taken to the 1.3.0 home page.
2018-09-21_11-41-27
This is so annoying. Now you have to go and search for that page again.

With this PR, changing versions does what you'd expect it to do!
2018-09-21_11-41-27-1

If you pick a doc that didn't exist in a previous version, you get a 404 error.
2018-09-21_11-41-27-2

@aaronmarkham aaronmarkham changed the title Doc api version Fix version dropdown Sep 21, 2018
@aaronmarkham aaronmarkham changed the title Fix version dropdown Fix version dropdown behavior Sep 21, 2018
@stu1130
Copy link
Contributor

stu1130 commented Sep 21, 2018

Thanks for your contribution @aaronmarkham
It's so sweet that you even made gifs.
@mxnet-label-bot[pr-awaiting-review]

@marcoabreu marcoabreu added the pr-awaiting-review PR is waiting for code review label Sep 21, 2018
@sandeep-krishnamurthy
Copy link
Contributor

This is super important ux improvement, thanks for following it up and fixing it.

Copy link
Member

@gigasquid gigasquid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me - Thanks for the gifs 💯

@nswamy nswamy merged commit 6614b0c into apache:master Sep 22, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants