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

Some improvements to install #1163

Closed
3 tasks done
javabster opened this issue Apr 12, 2024 · 3 comments · Fixed by #1721
Closed
3 tasks done

Some improvements to install #1163

javabster opened this issue Apr 12, 2024 · 3 comments · Fixed by #1721
Assignees
Labels
content 📄 good first issue 🐣 section: start work related to https://docs.quantum-computing.ibm.com/start

Comments

@javabster
Copy link
Collaborator

javabster commented Apr 12, 2024

Using this issue to collect ideas for improving the install page:

  • embed the latest CWQ install video into the page (https://www.youtube.com/watch?v=dZWz4Gs_BuI)
  • In step 1 - mention other python environments, like anaconda and miniconda
  • In step 2 - mention that you only need to install pip if you dont use a python environment, otherwise its already installed in the env
@javabster javabster added section: start work related to https://docs.quantum-computing.ibm.com/start good first issue 🐣 labels Apr 12, 2024
@iheuze
Copy link

iheuze commented Apr 14, 2024

I think a newcomer could easily be overwhelmed by all the text. I would strip back the steps to the absolute basics and then any extras can be included after. For example the note in step 3. I would either have that after the steps or as something you have to click to open.

I also don't think it is very clear where you put "pip install qiskit." Could add a bit about command prompts if you are using something like Spyder or else for Jupyter / Google Colab, you just run it like you would any other piece of code.

What do you think about including some screengrabs? I think it could make some parts easier to follow.

@abbycross
Copy link
Collaborator

I added the video at the top of the page in #1223.

github-merge-queue bot pushed a commit that referenced this issue Apr 24, 2024
Closes #1183, and also incorporates suggestions from #1163 (adds the
video and moves admonition statement "out of the way")

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
@beckykd beckykd moved this to In Progress in Docs Planning Jul 15, 2024
@beckykd
Copy link
Collaborator

beckykd commented Jul 15, 2024

What do you think about including some screengrabs? I think it could make some parts easier to follow.

Screenshots are tempting because they break up text, but we don't usually include them for several reasons: 1 - they aren't translatable, 2 - they go "stale" frequently 3 - they actually slow down users

github-merge-queue bot pushed a commit that referenced this issue Jul 17, 2024
closes #1163

---------

Co-authored-by: abbycross <across@us.ibm.com>
@github-project-automation github-project-automation bot moved this from In Progress to Done in Docs Planning Jul 17, 2024
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
Closes Qiskit#1183, and also incorporates suggestions from Qiskit#1163 (adds the
video and moves admonition statement "out of the way")

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
closes Qiskit#1163

---------

Co-authored-by: abbycross <across@us.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 📄 good first issue 🐣 section: start work related to https://docs.quantum-computing.ibm.com/start
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants