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

Migration guide for Qiskit 2.0 #2632

Open
jakelishman opened this issue Feb 10, 2025 · 2 comments
Open

Migration guide for Qiskit 2.0 #2632

jakelishman opened this issue Feb 10, 2025 · 2 comments
Assignees
Labels
content request request for new content to be added content 📄

Comments

@jakelishman
Copy link
Member

URL, if applicable

No response

Describe the new content you are requesting.

Qiskit 2.0's release date is the 20th of March, though in an ideal world we'll have at least a partial migration guide in place before the rc1 release on the 6th of March.

The Qiskit SDK team will help/actually write the content, but ideally we need a plan for collaboration on it, so several people can add sections to it without actually releasing it. We're happy to go with whatever workflow works sensibly for you, though the further we have to stray from the Sphinx build of Qiskit's API docs (especially writing custom MDX components or the like), probably the more friction there'll be.

If this new content request is accepted, do you want to write the content?

I will write a draft of the proposed content

@jakelishman jakelishman added content request request for new content to be added content 📄 needs triage 🤔 this issue needs to be prioritized by the docs team labels Feb 10, 2025
@javabster javabster added this to the 03-20 Qiskit 2.0 milestone Feb 13, 2025
@javabster
Copy link
Collaborator

Thanks for opening this Jake, atm we're at full capacity until 26th Feb, but will jump on this straight after. If you folks can get started on this between now and then that would be great, and then we'll come help as soon as we can.

To write a migration guide it should be fairly straightforward, if its very code heavy and you'd like people to download then you can write it as a jupyter notebook. If it's more explanatory you can write it in mdx format, which is v similar to regular markdown, you can check out an example here. Also there is some helpful mdx guidance here

Of course if you are struggling just let us know!

@javabster javabster removed the needs triage 🤔 this issue needs to be prioritized by the docs team label Feb 13, 2025
@ElePT
Copy link
Collaborator

ElePT commented Feb 19, 2025

I am not sure if this is the best place to keep track of this, but I am afraid that we might forget to add some, so just in case, here are some must-haves for the 2.0 migration guide:

  • Use of estimate_duration as a replacement for circuit.duration

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content request request for new content to be added content 📄
Projects
Status: No status
Development

No branches or pull requests

5 participants