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

Shorten and use kebab-case for qiskit-ibm-runtime URLs #2593

Merged
merged 49 commits into from
Jan 30, 2025

Conversation

arnaucasau
Copy link
Collaborator

This PR is a continuation of #2177 for all the versions of qiskit-ibm-runtime.

Once this PR is reviewed and accepted, I'll also set the redirects in closed source.

Copy link
Member

@frankharkins frankharkins left a comment

Choose a reason for hiding this comment

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

Thanks!

@Eric-Arellano
Copy link
Collaborator

Please don't merge until a) ibm-transpiler is 100% landed in prod, and b) you have the redirect code set up in closed source and we've reviewed it

@arnaucasau arnaucasau marked this pull request as draft January 23, 2025 14:54
@arnaucasau
Copy link
Collaborator Author

arnaucasau commented Jan 23, 2025

Thank you both for the review!

Please don't merge until...

Yes! That was my plan 👍


In the last commit (0314cff), I changed the normalizeUrl function to update the links that point to the same API (mainly for the release-notes). In 78a4e5e, I updated them with another script I wrote, so this change is needed to avoid reverting the changes when regenerating the docs.

I think the change is safe, and I tested it by regenerating qiskit (latest, and one historical version), qiskit-addon-obp (currently using the new URLs), and runtime (latest, and one historical version). None of them showed any change in the docs.

Once all versions use the new URLs, we can change it to update links from /api in general. That way we will fix cross-reference between APIs.

@arnaucasau
Copy link
Collaborator Author

I updated the script to special case URLs with a version (e.g. v1 or v2) in 1cbca72. To help with the review of that change, I regenerated every version in a different commit again. That way, we can check that the change didn't affect any other link.

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

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

Thanks! Bummer the diff treats some files as being deleted. The redirect code looks good too, so this can be merged when you're ready.

@arnaucasau arnaucasau marked this pull request as ready for review January 28, 2025 12:39
@arnaucasau arnaucasau added this pull request to the merge queue Jan 30, 2025
Merged via the queue into Qiskit:main with commit 5361362 Jan 30, 2025
3 checks passed
@arnaucasau arnaucasau deleted the AC/runtime-new-urls branch January 30, 2025 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants