Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Design: allow changing historical API version filter in search? #1080

Open
Tracked by #1065
Eric-Arellano opened this issue Mar 25, 2024 · 2 comments
Open
Tracked by #1065

Design: allow changing historical API version filter in search? #1080

Eric-Arellano opened this issue Mar 25, 2024 · 2 comments
Assignees

Comments

@Eric-Arellano
Copy link
Collaborator

Follow up to #859.

We want to signal to the user that your search for the current API will be filtered to use the historical API version for that API, rather than the current version. For example, if you're at /api/qiskit/0.19, then we'll search Qiskit 0.19 rather than latest of 1.0. But we still use 'latest' for the other APIs like Runtime. So, show something like Qiskit SDK 0.19.

This shouldn't be a changeable element, meaning you don't change the search filter via the search bar. Instead, you change the API version with the API version switcher in the left sidebar:

Screenshot 2024-03-25 at 9 15 25 AM

One concern is how much screen real estate this label might take up, such as to show the text 'Qiskit IBM Runtime Client 0.17'.

Consider with the design how we'll want to handle translations, if we show when search is being filtered to e.g. Spanish.

@Eric-Arellano Eric-Arellano changed the title Design: search should show when historical API doc filter is used Design: allow changing historical API version filter in search? Apr 15, 2024
@Eric-Arellano
Copy link
Collaborator Author

#859 ended up adding a frontend, as screenshotted there. This issue is now about whether we want to allow users to change the search filter in a way different than changing the API url.

@Eric-Arellano
Copy link
Collaborator Author

Update: @Vanguardbots is going to re-investigate this. We clarified that you do not need to change the URL to be able to search different API versions. We can search whatever we want from any page.

However, it's important that only one version of an API is searched at a time, e.g. only Qiskit 1.1 or 0.46, not both.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

2 participants