Automatically publish tutorials to learning platform #1111
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
Just waiting on a fix to the learning API, and then we'll need to add the secrets. |
Pull Request Test Coverage Report for Build 6905812838
💛 - Coveralls |
|
@frankharkins what's the status of this PR? Let me know if you need anything from the runtime side |
|
@kt474 this PR is ready for review please. If approved, the only other action is to add the secrets, I'll Slack you with more info on that. |
There was a problem hiding this comment.
Mostly looks good to me - just to make sure, will the tutorials still render correctly in the qiskit org docs? https://qiskit.org/ecosystem/ibm-runtime/
| run: | | ||
| pip install git+https://github.com/frankharkins/learning-content-tools.git@12a71a904b0283b2ee44b63cd04ab8fe96e0df6f#subdirectory=iql-lesson-sync | ||
| cd docs/tutorials |
There was a problem hiding this comment.
Should this repo be in the qiskit org? Seems a bit odd to have to install something from your personal repo
There was a problem hiding this comment.
That's true, I'll look into it. Is it a requirement for this PR?
There was a problem hiding this comment.
Could the tools live in qiskit/documentation? I agree this is an issue for sustainability - it's high bus factor.
There was a problem hiding this comment.
Could the tools live in qiskit/documentation?
That works for me!
Yes, only difference is they'll be at |
| run: | | ||
| pip install git+https://github.com/frankharkins/learning-content-tools.git@12a71a904b0283b2ee44b63cd04ab8fe96e0df6f#subdirectory=iql-lesson-sync | ||
| cd docs/tutorials |
There was a problem hiding this comment.
Could the tools live in qiskit/documentation? I agree this is an issue for sustainability - it's high bus factor.
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
…/qiskit-ibm-runtime into fh-upload-tutorials
Relative links will not work on the learning platform as they don't get resolved to the real urls
This moves a custom tool from https://github.com/frankharkins/learning-content-tools to this repo as per [request](Qiskit/qiskit-ibm-runtime#1111 (comment)). This tool is not actually used in this repo, it will just live here to be owned by the Qiskit organisation. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
|
Should this work be moved over to https://github.com/Qiskit/documentation/issues now that the docs have been removed from this repo? |
|
My understanding is that the Learning tutorials will still live in this repository, including so that we can test them in CI more easily. |
|
Going to close this for now, feel free to reopen |
This moves a custom tool from https://github.com/frankharkins/learning-content-tools to this repo as per [request](Qiskit/qiskit-ibm-runtime#1111 (comment)). This tool is not actually used in this repo, it will just live here to be owned by the Qiskit organisation. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Summary
This PR uses GitHub actions to automatically publish tutorials to...
mainrcin the name)Details
The upload script requires each notebook to be in its own folder with any images. This PR also rearranges the tutorial notebooks to this order, and uses redirects to avoid broken links. Removed some unused images in the process.
Version tables currently break the learning platform too, so I've removed these as there's already a
qiskit_ibm_runtime.version.get_version_info()in most tutorials.