Qiskit / documentation

The documentation content home for https://docs.quantum.ibm.com.
https://docs.quantum.ibm.com
Apache License 2.0
29 stars 48 forks source link

Tutorial housekeeping #1286

Open javabster opened 2 months ago

javabster commented 2 months ago

There are some small differences between all the existing tutorials that we should clean up.

All the tutorials currently on learning:

This issue applies to both open and network tutorials

### Tasks
- [ ] https://github.com/Qiskit/documentation/pull/1379
- [ ] https://github.com/Qiskit/documentation/pull/1518
- [ ] https://github.com/Qiskit/documentation/pull/1519
- [ ] https://github.com/Qiskit/documentation/pull/1521
- [ ] https://github.com/Qiskit/documentation/pull/1531
- [ ] https://github.com/Qiskit/documentation/pull/1540
abbycross commented 2 months ago

Related issue: #1189

javabster commented 2 months ago

I wasnt able to find a single tutorial that does everything we want, but here are a couple that have good stuff:

javabster commented 2 months ago

The tutorials that should be reviewed as part of this PR:

javabster commented 2 months ago

another thing that would be good to add to each tutorial (but not sure how feasible it is) is an estimate of how much QPU time it takes. e.g. could this tutorial be run within the 10min open plan, or is it many hours so recommended to use serverless

javabster commented 1 month ago

example notice: QPU time estimate: ~X QPU minutes on Y backend (NOTE: this is an estimate only, your runtimes may vary)

abbycross commented 1 month ago

@beckykd pointed out that the tutorials have a little clock icon and a time listed, which is the estimated time it takes to read that tutorial. When we start listing the QPU time too, it has the potential to be confusing, especially since the time-to-read is not labeled (only with the icon, and there's no hover text).

@javabster do we want both times listed on every tutorial? If so, we might want to get design help to make it clearer what the clock icon time means, so as not to confuse with the QPU time that we list in the tutorial itself.

beckykd commented 1 month ago

@abbycross noticed that we have a couple of tutorials that start with a small example, then "beef it up" to be utility-scale (or closer). Would that be a good pattern to follow everywhere? It might make open users able to run more of the tutorials.

beckykd commented 3 weeks ago

@abbycross and I landed on this text:

QPU time estimate: x minutes, y seconds on ibm_xyz. (NOTE: This is an estimate only. Your runtime may vary.)

beckykd commented 3 weeks ago
  • For consistent subheading naming checkout this one

Some notes on this text:

  1. There should not be periods in headings.
  2. "Primitives" in "Qiskit primitives" should be lower case.
beckykd commented 3 weeks ago

@abbycross and I landed on this text:

QPU time estimate: x minutes, y seconds on ibm_xyz. (NOTE: This is an estimate only. Your runtime may vary.)

Raul said that "Usage" would be a more accurate term than "QPU".