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

Include upgrading to Qiskit 1.0 on install page #634

Merged
merged 16 commits into from
Feb 15, 2024

Conversation

abbycross
Copy link
Collaborator

@abbycross abbycross commented Jan 16, 2024

Closes #631

To be merged once Qiskit 1.0 is live and not earlier.

docs/start/install.mdx Outdated Show resolved Hide resolved
@@ -8,6 +8,14 @@ description: Install and set up Qiskit and Qiskit Runtime on various operating s

Whether you will work locally or in a cloud environment, the first step for all users is to install Qiskit. For those wanting to run on a real system, your next step is to choose one of two channels in order to access IBM Quantum systems: IBM Quantum Platform or IBM Cloud.

<span id="qiskit-upgrade"></span>
## Upgrade to Qiskit 1.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
## Upgrade to Qiskit 1.0
## Upgrade to Qiskit 1.0 requires deleting virtual environment

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@Eric-Arellano the blog doesn't mention explicitly deleting the current virtual environment. Is that implied when creating a new one? And do we need extra instructions on how to delete the current one?

Copy link
Collaborator

Choose a reason for hiding this comment

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

The important thing is to have a new venv, either by creating a brand new one with a new name or by deleting the old one and recreating it. Imo recreating is often the easiest, where you e.g. rm -rf .venv then create a new one at .venv.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure how best to do this, but I think we should make it clear somehow that this info is important for existing users of qiskit. Brand new users can use the install page as normal. Maybe just the header should be changed, or else the first line could tell people to skip this section if they are a new user?

@abbycross
Copy link
Collaborator Author

abbycross commented Jan 17, 2024

Question for @javabster - Re: the headings below -- will the content under these headings in the blog also need to live somewhere in our docs? I hesitate to add on the Install page, in the interest of not overcrowding the text there, unless absolutely necessary. It would be nice to be able to point from the Install page to somewhere else.

I use projects that depend on Qiskit . What do I need to do?
I maintain a project that depends on Qiskit . What do I need to do?
Breaking changes

Co-authored-by: Eric Arellano <[email protected]>
@@ -8,6 +8,14 @@ description: Install and set up Qiskit and Qiskit Runtime on various operating s

Whether you will work locally or in a cloud environment, the first step for all users is to install Qiskit. For those wanting to run on a real system, your next step is to choose one of two channels in order to access IBM Quantum systems: IBM Quantum Platform or IBM Cloud.

<span id="qiskit-upgrade"></span>
## Upgrade to Qiskit 1.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure how best to do this, but I think we should make it clear somehow that this info is important for existing users of qiskit. Brand new users can use the install page as normal. Maybe just the header should be changed, or else the first line could tell people to skip this section if they are a new user?

docs/start/install.mdx Outdated Show resolved Hide resolved
docs/start/install.mdx Outdated Show resolved Hide resolved
docs/start/install.mdx Outdated Show resolved Hide resolved
docs/start/install.mdx Outdated Show resolved Hide resolved
@abbycross abbycross marked this pull request as ready for review January 24, 2024 16:37
@abbycross abbycross changed the title Include upgrading to Qiskit 1.0 on install page [DO NOT MERGE YET] Include upgrading to Qiskit 1.0 on install page Jan 24, 2024
docs/start/install.mdx Outdated Show resolved Hide resolved
docs/start/install.mdx Outdated Show resolved Hide resolved
@abbycross abbycross changed the title [DO NOT MERGE YET] Include upgrading to Qiskit 1.0 on install page Include upgrading to Qiskit 1.0 on install page Feb 15, 2024
@abbycross abbycross added this pull request to the merge queue Feb 15, 2024
Merged via the queue into main with commit 408cadb Feb 15, 2024
4 checks passed
@abbycross abbycross deleted the ajc-upgrade-to-qiskit-1.0 branch February 15, 2024 16:26
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Closes Qiskit#631 

To be merged once Qiskit 1.0 is live and not earlier.

---------

Co-authored-by: Eric Arellano <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Update Install page with 1.0 info
4 participants