Remove algorithms tutorials #10682
Remove algorithms tutorials #10682
Conversation
Eric-Arellano
added
documentation
Eric-Arellano
requested review from
woodsp-ibm,
ElePT and
a team
as code owners
|
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 5940217275
💛 - Coveralls |
There was a problem hiding this comment.
I think in principle this is ok, though it still feels a bit wrong to merge it before the alternatives are published (even if the redirects are currently borking the links - that's kind of a separate problem).
Would it be appropriate to put a little note at the bottom of the index page saying
Looking for tutorials on algorithms? They've moved to a separate package here [...]
or something like that?
|
FYI, the |
Good idea! I also added a warning about the operators tutorials. Once we copy over the tutorials to live in Terra, I want to add a warning to the top of those tutorials too.
I think it's a related problem. There's no reason to have the tutorials currently because the redirects botch it. We're one day away from the live release. Also, there's a slow turnaround for changes to our Cloudflare config, which is why the redirects got set up prematurely in the first place to try to get ahead of that. So, it would not make sense to try to remove the bad redirects today, then add them back tomorrow. |
| The Simulators tutorials have moved to | ||
| `Qiskit Aer <https://qiskit.org/ecosystem/aer/tutorials/index.html>`_ | ||
| and the Algorithms tutorials to | ||
| `Qiskit Algorithms <https://qiskit.org/ecosystem/algorithms/tutorials/index.html>`_. |
There was a problem hiding this comment.
Does it make sense to say a little more here? Not only have they moved, to take advantage of them you also need to refactor any code you have over from qiskit.algorithms to qiskit_algorithms. There is some text in the Qiskit release notes around that - this does not link to it exactly but its in the prelude https://qiskit.org/documentation/release_notes.html#release-notes-0-25-0-prelude Also qiskit_algorithms release note says something similar https://qiskit.org/ecosystem/algorithms/release_notes.html#release-notes-0-1-0 if thats preferable.
There was a problem hiding this comment.
This seems like a warning that would better fit the documentation on the qiskit_algorithms side, we could add a note there warning about the change in the tutorials with respect to qiskit.
|
FYI the tutorials are now live: https://qiskit.org/ecosystem/algorithms/tutorials/index.html |
* Remove algorithms tutorials * Also update github * Add guidance on tutorials index page * Bad version equivalency (cherry picked from commit 021b0ff)
The algorithm tutorials now live in https://github.com/qiskit-community/qiskit-algorithms as of qiskit-community/qiskit-algorithms#44.
We (slightly prematurely) already set up redirects from
qiskit.org/documentation/tutorials/algorithms/*toqiskit.org/ecosystem/algorithms/tutorials/index.html. So there is no reason to keep the tutorials in Qiskit anymore.This is prework for copying over the qiskit-tutorials repository because we will not copy over the algorithms files to this repo.
We deployed the redirects before the new tutorials are actually live on the Ecosystem site due to bad coordination. My bad.