Plan to rename Qiskit/qiskit-terra repo to Qiskit/qiskit
#31
Conversation
####-repo-rename.md
Outdated
|
|
||
|
|
||
| ## Summary | ||
| In 2021, Qiskit began an evolution from a large monolithic install, which included by default the Aer simulator, the IBM Quantum provider, and large characterization and application libraries, into a leaner and more modular structure. |
There was a problem hiding this comment.
Maybe it's worth putting a link to the blog post that announced that: https://research.ibm.com/blog/qiskit-application-modules (I never quite understood why we published that on the ibm research blog it should have been on the qiskit blog).
There was a problem hiding this comment.
Good reference. Added in 7707c55
####-repo-rename.md
Outdated
| * **docs-out-of-metapackage**: Move documents from `qiskit/qiskit-metapackage` to `qiskit/qiskit-terra`. All the ["general documents"](https://github.com/Qiskit/qiskit/tree/master/docs) in needs to be moved to the `qiskit/qiskit-terra` to be part of a single sphinx build process. The [`qiskit-ibmq-provider` documentation](https://qiskit.org/documentation/apidoc/ibmq-provider.html) cannot be move to `qiskit/qiskit-terra`. Therefore, the options are: | ||
| * Wait until the stage ibmq-out-of-metapackage when the documentation can be removed as the repo `qiskit/qiskit-ibmq-provider` gets archived. | ||
| * Create a landing page in `qiskit.org/documentation/ibmq-provider` or `qiskit.org/ecosystem/ibmq-provider` [like Aer did](https://github.com/Qiskit/qiskit-aer/pull/1589). | ||
| * **benchmarks-out-of-metapackage**: Move benchmarks from `qiskit/qiskit-metapackage` to `qiskit/qiskit-benchmarks` (repo to create). Change the related scripts to continue running and deploying <https://qiskit.github.io/qiskit/>. |
There was a problem hiding this comment.
Two things on this item. We don't necessarily have to do it via a separate repository we could put the benchmarks in the qiskit-terra (future qiskit) repo. We also don't have to use github pages for hosting either. It's just generating a static webpage so if we wanted we can put that on qiskit.org/benchmarks or something like that too. Both can be decided independently, basically we have 4 options:
- New repo & github pages
- qiskit-terra repo & github pages
- New repo & qiskit.org hosting
- qiskit-terra repo and & qiskit.org hosting
If we were determined to keep https://qiskit.github.io/qiskit/ then the only option to do this is option 2. Historically I've been opposed to option 2 because it led to a lot of repository bloat to contain the gh pages branch in the repo. But a recent configuration change to force push a single commit instead of maintaining the change history reduces that a lot.
Personally, I don't think having url continuity/redirects in place for the existing benchmark results is super critical. As long as all the data is there just using a new url isn't a big deal, so we should pick the option that we like best.
There was a problem hiding this comment.
Options added in f1a7289 . I also do not feel very strong about any option in particular, but I lean towards not having them in qiskit.org, as it is a dev tool (it can be linked in the contributor guidelines).
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
|
I think this is ready for approval and merge. |
This RFC is about planning the
Qiskit/qiskit-terra->Qiskit/qiskitrename. It will be open for comments and feedback for 15-ish days (April 15th-ish).