migrate files from qiskit-ibm-runtime to Qiskit/docs and convert .rst files to .mdx
#23
Comments
|
I'll walk through all of the runtime pages this afternoon. But No, we shouldn't move over the Cloud folder, Yes, the information in the Migration files is already covered in 1xp. These were some victims of the idea that we just needed fewer topics in the left hand nav, so they've been squashed together. We could pull them back apart if we want. My guess is that the vast majority of the files in Runtime are in 1xp, but we'll need to carefully compare the content for updates. Update: I verified that every file that should be migrated to 1xp has already been migrated. I put them in a table if you're interested. I have not done a close compare yet though. |
Merged
Eric-Arellano
added a commit
that referenced
this issue
Oct 9, 2023
First part of #22 and #23. This copies over the open source files we plan to use in this repository. They are not actually used yet and still require some work like converting RST to MDX, but it gets the files and their Git history here to start the process. Qiskit docs are placed in the folder `qiskit-docs/` and Runtime docs in `runtime-docs`. These are only for unprocessed docs. Once a document is ready, we will move it to the official `docs/` folder and have it go live. This uses `git-filter-repo` to preserve all the Git history and author attribution from the respective open source repositories. It uses the below Python script and this [zipped folder](https://github.com/Qiskit/documentation/files/12835669/migrate-open-source.zip), using an approach very similar to @jakelishman's original work in Qiskit/qiskit#10611. This PR has no additional commits. It solely copies over the other repositories into this one. ``` # Runtime files docs/faqs/max_execution_time.rst docs/faqs/open_source_vs_ibm_cloud_primitives.rst ``` ``` # Qiskit files # start/ docs/migration_guides/algorithms_migration.rst docs/migration_guides/opflow_migration.rst docs/migration_guides/qi_migration.rst # build/ docs/tutorials/circuits/01_circuit_basics.ipynb docs/tutorials/circuits/1_getting_started_with_qiskit.ipynb docs/tutorials/circuits/2_plotting_data_in_qiskit.ipynb docs/tutorials/circuits_advanced/01_advanced_circuits.ipynb docs/tutorials/circuits_advanced/02_operators_overview.ipynb docs/tutorials/circuits_advanced/05_pulse_gates.ipynb docs/tutorials/circuits_advanced/06_building_pulse_schedules.ipynb docs/tutorials/circuits_advanced/07_pulse_scheduler.ipynb docs/explanation/endianness.rst # transpile/ docs/tutorials/circuits_advanced/04_transpiler_passes_and_passmanager.ipynb # test/ docs/how_to/use_estimator.rst docs/how_to/use_sampler.rst # run/ docs/tutorials/circuits_advanced/08_gathering_system_information.ipynb # other/ docs/faq.rst # Tutorial renames from the original qiskit-tutorials repo docs/tutorials/terra/fundamentals/1_getting_started_with_qiskit.ipynb docs/tutorials/terra/fundamentals/2_plotting_data_in_qiskit.ipynb docs/tutorials/terra/fundamentals/3_summary_of_quantum_operations.ipynb docs/tutorials/terra/advanced/1_advanced_circuits.ipynb docs/tutorials/terra/advanced/2_operators_overview.ipynb docs/tutorials/terra/advanced/3_advanced_circuit_visualization.ipynb docs/tutorials/terra/advanced/4_transpiler_passes_and_passmanager.ipynb docs/tutorials/circuits_advanced/1_advanced_circuits.ipynb docs/tutorials/circuits_advanced/2_operators_overview.ipynb docs/tutorials/circuits_advanced/3_advanced_circuit_visualization.ipynb docs/tutorials/circuits_advanced/4_transpiler_passes_and_passmanager.ipynb ``` Migration script: ```python import subprocess from tempfile import TemporaryDirectory from pathlib import Path QISKIT_ROOT = Path("../qiskit") RUNTIME_ROOT = Path("../qiskit-ibm-runtime") DOCS_ROOT = Path("./").resolve() # Expects script author to have this folder created. MIGRATION_FOLDER = DOCS_ROOT / "migrate-open-source" MAILMAP = MIGRATION_FOLDER / "mailmap.txt" def main() -> None: with TemporaryDirectory() as tmpdir: qiskit_dir = clone_repo(tmpdir, repo_name="qiskit") git_filter_repo( qiskit_dir, "qiskit-files.txt", "qiskit-messages.txt", dest_folder="qiskit-docs", ) merge_repo(qiskit_dir, remote_name="qiskit") runtime_dir = clone_repo(tmpdir, repo_name="qiskit-ibm-runtime") git_filter_repo( runtime_dir, "runtime-files.txt", "runtime-messages.txt", dest_folder="runtime-docs", ) merge_repo(runtime_dir, remote_name="runtime") def clone_repo(tmpdir: str, repo_name: str) -> Path: subprocess.run( [ "git", "clone", "--no-tags", "--single-branch", f"https://github.com/Qiskit/{repo_name}.git", ], check=True, cwd=tmpdir, ) return Path(tmpdir, repo_name) def git_filter_repo( repo_path: str, files_txt_name: str, msg_txt_file: str, dest_folder: str ) -> None: subprocess.run( [ "python3", MIGRATION_FOLDER / "git-filter-repo", "--paths-from-file", MIGRATION_FOLDER / files_txt_name, "--replace-message", MIGRATION_FOLDER / msg_txt_file, "--mailmap", MAILMAP, "--path-rename", f"docs/:{dest_folder}/", ], check=True, cwd=repo_path, ) def merge_repo(repo_path: str, remote_name: str) -> None: subprocess.run(["git", "remote", "add", remote_name, repo_path], check=True) subprocess.run(["git", "fetch", remote_name]) subprocess.run( ["git", "merge", "--allow-unrelated-histories", f"{remote_name}/main"] ) subprocess.run(["git", "remote", "remove", remote_name]) main() ``` --------- Co-authored-by: Paul Kassebaum <paul.kassebaum@ibm.com> Co-authored-by: Soolu Thomas <soolu.thomas@ibm.com> Co-authored-by: Laura Zdanski <Laura.Zdanski@ibm.com> Co-authored-by: Jay M. Gambetta <jay.gambetta@us.ibm.com> Co-authored-by: Diego M. Rodríguez <diego.plan9@gmail.com> Co-authored-by: Paul Nation <nonhermitian@gmail.com> Co-authored-by: Matthew Treinish <mtreinish@kortar.org> Co-authored-by: 3yakuya <3yakuya@outlook.com> Co-authored-by: Sristy Sangskriti <sristysangskriti007@gmail.com> Co-authored-by: Vismai Khanderao <59114226+Vismai-Khanderao@users.noreply.github.com> Co-authored-by: Wei Hu <wei.hu@kfquantum.com> Co-authored-by: gunchamalik <gunchamalik@gmail.com> Co-authored-by: zodiacfireworks <martin.vuelta@gmail.com> Co-authored-by: Emixem <64846036+Emixem@users.noreply.github.com> Co-authored-by: Julien Gacon <jul@zurich.ibm.com> Co-authored-by: wagnersj <wagnerse@ca.ibm.com> Co-authored-by: Bruno E. Ramírez Galindo <47431792+brunormzg@users.noreply.github.com> Co-authored-by: Peter J <peter.j@kakao.com> Co-authored-by: Kevin Krsulich <kevin.krsulich@ibm.com> Co-authored-by: Lauren Capelluto <lcapelluto@users.noreply.github.com> Co-authored-by: Luciano Bello <luciano.bello@ibm.com> Co-authored-by: Thomas Alexander <talexander@ibm.com> Co-authored-by: Divyanshu Singh <55018955+divshacker@users.noreply.github.com> Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> Co-authored-by: jaleipekoglu <47296000+jaleipekoglu@users.noreply.github.com> Co-authored-by: SooluThomas <soolu.elto@gmail.com> Co-authored-by: Manoel Marques <manoel@us.ibm.com> Co-authored-by: Eli Arbel <arbel@il.ibm.com> Co-authored-by: Parmeet Singh <76438148+singhmeet11@users.noreply.github.com> Co-authored-by: Aurélien Pupier <apupier@redhat.com> Co-authored-by: Ali Javadi-Abhari <ali.javadi@ibm.com> Co-authored-by: Kevin Krsulich <kevin@krsulich.net> Co-authored-by: Naoki Kanazawa <39517270+nkanazawa1989@users.noreply.github.com> Co-authored-by: Claudia Zendejas-Morales <ing.claudia@gmail.com> Co-authored-by: Glen <96159532+NG-Glen@users.noreply.github.com> Co-authored-by: Edwin Navarro <enavarro@comcast.net> Co-authored-by: Junye Huang <h.jun.ye@gmail.com> Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> Co-authored-by: Kazuki Tsuoka <103920010+king-p3nguin@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: InfamousPlatypus <45645300+InfamousPlatypus@users.noreply.github.com> Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Filippo Tramonto <11334590+filippotramonto@users.noreply.github.com> Co-authored-by: Kazuki Tsuoka <kazukitsuoka@g.ecc.u-tokyo.ac.jp> Co-authored-by: Kevin Hartman <kevin@hart.mn> Co-authored-by: Frank Harkins <frankharkins@users.noreply.github.com> Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> Co-authored-by: Declan Millar <declan.millar@ibm.com> Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com> Co-authored-by: Kevin Tian <kevin.tian@ibm.com> Co-authored-by: Emil Magni <emilmagni@gmail.com> Co-authored-by: Will Shanks <wshaos@posteo.net> Co-authored-by: Jim Garrison <jim@garrison.cc> Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk> Co-authored-by: Jessie Yu <jessieyu@us.ibm.com> Co-authored-by: Ikko Eltociear Ashimine <eltociear@gmail.com> Co-authored-by: Mehmet Keçeci <WhiteSymmetry@users.noreply.github.com> Co-authored-by: Kuba Pilch <6464505+3yakuya@users.noreply.github.com> Co-authored-by: Soon Teh <11854984+soon-teh@users.noreply.github.com> Co-authored-by: Jake Lishman <jake.lishman@ibm.com> Co-authored-by: Shilpa Mahato <61791872+shil-m@users.noreply.github.com> Co-authored-by: Elbert <67720913+elberttl@users.noreply.github.com> Co-authored-by: Bochen "Daniel" Tan <33230390+tbcdebug@users.noreply.github.com> Co-authored-by: Kevin Tian <kt474@cornell.edu> Co-authored-by: Alexander Ivrii <alexi@il.ibm.com> Co-authored-by: rht <rhtbot@protonmail.com>
Eric-Arellano
added a commit
that referenced
this issue
Oct 9, 2023
The content is already covered in the current docs, so it wasn't necessary to bring this over in the first place. Closes #23.
frankharkins
added a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
First part of Qiskit#22 and Qiskit#23. This copies over the open source files we plan to use in this repository. They are not actually used yet and still require some work like converting RST to MDX, but it gets the files and their Git history here to start the process. Qiskit docs are placed in the folder `qiskit-docs/` and Runtime docs in `runtime-docs`. These are only for unprocessed docs. Once a document is ready, we will move it to the official `docs/` folder and have it go live. This uses `git-filter-repo` to preserve all the Git history and author attribution from the respective open source repositories. It uses the below Python script and this [zipped folder](https://github.com/Qiskit/documentation/files/12835669/migrate-open-source.zip), using an approach very similar to @jakelishman's original work in Qiskit/qiskit#10611. This PR has no additional commits. It solely copies over the other repositories into this one. ``` # Runtime files docs/faqs/max_execution_time.rst docs/faqs/open_source_vs_ibm_cloud_primitives.rst ``` ``` # Qiskit files # start/ docs/migration_guides/algorithms_migration.rst docs/migration_guides/opflow_migration.rst docs/migration_guides/qi_migration.rst # build/ docs/tutorials/circuits/01_circuit_basics.ipynb docs/tutorials/circuits/1_getting_started_with_qiskit.ipynb docs/tutorials/circuits/2_plotting_data_in_qiskit.ipynb docs/tutorials/circuits_advanced/01_advanced_circuits.ipynb docs/tutorials/circuits_advanced/02_operators_overview.ipynb docs/tutorials/circuits_advanced/05_pulse_gates.ipynb docs/tutorials/circuits_advanced/06_building_pulse_schedules.ipynb docs/tutorials/circuits_advanced/07_pulse_scheduler.ipynb docs/explanation/endianness.rst # transpile/ docs/tutorials/circuits_advanced/04_transpiler_passes_and_passmanager.ipynb # test/ docs/how_to/use_estimator.rst docs/how_to/use_sampler.rst # run/ docs/tutorials/circuits_advanced/08_gathering_system_information.ipynb # other/ docs/faq.rst # Tutorial renames from the original qiskit-tutorials repo docs/tutorials/terra/fundamentals/1_getting_started_with_qiskit.ipynb docs/tutorials/terra/fundamentals/2_plotting_data_in_qiskit.ipynb docs/tutorials/terra/fundamentals/3_summary_of_quantum_operations.ipynb docs/tutorials/terra/advanced/1_advanced_circuits.ipynb docs/tutorials/terra/advanced/2_operators_overview.ipynb docs/tutorials/terra/advanced/3_advanced_circuit_visualization.ipynb docs/tutorials/terra/advanced/4_transpiler_passes_and_passmanager.ipynb docs/tutorials/circuits_advanced/1_advanced_circuits.ipynb docs/tutorials/circuits_advanced/2_operators_overview.ipynb docs/tutorials/circuits_advanced/3_advanced_circuit_visualization.ipynb docs/tutorials/circuits_advanced/4_transpiler_passes_and_passmanager.ipynb ``` Migration script: ```python import subprocess from tempfile import TemporaryDirectory from pathlib import Path QISKIT_ROOT = Path("../qiskit") RUNTIME_ROOT = Path("../qiskit-ibm-runtime") DOCS_ROOT = Path("./").resolve() # Expects script author to have this folder created. MIGRATION_FOLDER = DOCS_ROOT / "migrate-open-source" MAILMAP = MIGRATION_FOLDER / "mailmap.txt" def main() -> None: with TemporaryDirectory() as tmpdir: qiskit_dir = clone_repo(tmpdir, repo_name="qiskit") git_filter_repo( qiskit_dir, "qiskit-files.txt", "qiskit-messages.txt", dest_folder="qiskit-docs", ) merge_repo(qiskit_dir, remote_name="qiskit") runtime_dir = clone_repo(tmpdir, repo_name="qiskit-ibm-runtime") git_filter_repo( runtime_dir, "runtime-files.txt", "runtime-messages.txt", dest_folder="runtime-docs", ) merge_repo(runtime_dir, remote_name="runtime") def clone_repo(tmpdir: str, repo_name: str) -> Path: subprocess.run( [ "git", "clone", "--no-tags", "--single-branch", f"https://github.com/Qiskit/{repo_name}.git", ], check=True, cwd=tmpdir, ) return Path(tmpdir, repo_name) def git_filter_repo( repo_path: str, files_txt_name: str, msg_txt_file: str, dest_folder: str ) -> None: subprocess.run( [ "python3", MIGRATION_FOLDER / "git-filter-repo", "--paths-from-file", MIGRATION_FOLDER / files_txt_name, "--replace-message", MIGRATION_FOLDER / msg_txt_file, "--mailmap", MAILMAP, "--path-rename", f"docs/:{dest_folder}/", ], check=True, cwd=repo_path, ) def merge_repo(repo_path: str, remote_name: str) -> None: subprocess.run(["git", "remote", "add", remote_name, repo_path], check=True) subprocess.run(["git", "fetch", remote_name]) subprocess.run( ["git", "merge", "--allow-unrelated-histories", f"{remote_name}/main"] ) subprocess.run(["git", "remote", "remove", remote_name]) main() ``` --------- Co-authored-by: Paul Kassebaum <paul.kassebaum@ibm.com> Co-authored-by: Soolu Thomas <soolu.thomas@ibm.com> Co-authored-by: Laura Zdanski <Laura.Zdanski@ibm.com> Co-authored-by: Jay M. Gambetta <jay.gambetta@us.ibm.com> Co-authored-by: Diego M. Rodríguez <diego.plan9@gmail.com> Co-authored-by: Paul Nation <nonhermitian@gmail.com> Co-authored-by: Matthew Treinish <mtreinish@kortar.org> Co-authored-by: 3yakuya <3yakuya@outlook.com> Co-authored-by: Sristy Sangskriti <sristysangskriti007@gmail.com> Co-authored-by: Vismai Khanderao <59114226+Vismai-Khanderao@users.noreply.github.com> Co-authored-by: Wei Hu <wei.hu@kfquantum.com> Co-authored-by: gunchamalik <gunchamalik@gmail.com> Co-authored-by: zodiacfireworks <martin.vuelta@gmail.com> Co-authored-by: Emixem <64846036+Emixem@users.noreply.github.com> Co-authored-by: Julien Gacon <jul@zurich.ibm.com> Co-authored-by: wagnersj <wagnerse@ca.ibm.com> Co-authored-by: Bruno E. Ramírez Galindo <47431792+brunormzg@users.noreply.github.com> Co-authored-by: Peter J <peter.j@kakao.com> Co-authored-by: Kevin Krsulich <kevin.krsulich@ibm.com> Co-authored-by: Lauren Capelluto <lcapelluto@users.noreply.github.com> Co-authored-by: Luciano Bello <luciano.bello@ibm.com> Co-authored-by: Thomas Alexander <talexander@ibm.com> Co-authored-by: Divyanshu Singh <55018955+divshacker@users.noreply.github.com> Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> Co-authored-by: jaleipekoglu <47296000+jaleipekoglu@users.noreply.github.com> Co-authored-by: SooluThomas <soolu.elto@gmail.com> Co-authored-by: Manoel Marques <manoel@us.ibm.com> Co-authored-by: Eli Arbel <arbel@il.ibm.com> Co-authored-by: Parmeet Singh <76438148+singhmeet11@users.noreply.github.com> Co-authored-by: Aurélien Pupier <apupier@redhat.com> Co-authored-by: Ali Javadi-Abhari <ali.javadi@ibm.com> Co-authored-by: Kevin Krsulich <kevin@krsulich.net> Co-authored-by: Naoki Kanazawa <39517270+nkanazawa1989@users.noreply.github.com> Co-authored-by: Claudia Zendejas-Morales <ing.claudia@gmail.com> Co-authored-by: Glen <96159532+NG-Glen@users.noreply.github.com> Co-authored-by: Edwin Navarro <enavarro@comcast.net> Co-authored-by: Junye Huang <h.jun.ye@gmail.com> Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> Co-authored-by: Kazuki Tsuoka <103920010+king-p3nguin@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: InfamousPlatypus <45645300+InfamousPlatypus@users.noreply.github.com> Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Filippo Tramonto <11334590+filippotramonto@users.noreply.github.com> Co-authored-by: Kazuki Tsuoka <kazukitsuoka@g.ecc.u-tokyo.ac.jp> Co-authored-by: Kevin Hartman <kevin@hart.mn> Co-authored-by: Frank Harkins <frankharkins@users.noreply.github.com> Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> Co-authored-by: Declan Millar <declan.millar@ibm.com> Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com> Co-authored-by: Kevin Tian <kevin.tian@ibm.com> Co-authored-by: Emil Magni <emilmagni@gmail.com> Co-authored-by: Will Shanks <wshaos@posteo.net> Co-authored-by: Jim Garrison <jim@garrison.cc> Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk> Co-authored-by: Jessie Yu <jessieyu@us.ibm.com> Co-authored-by: Ikko Eltociear Ashimine <eltociear@gmail.com> Co-authored-by: Mehmet Keçeci <WhiteSymmetry@users.noreply.github.com> Co-authored-by: Kuba Pilch <6464505+3yakuya@users.noreply.github.com> Co-authored-by: Soon Teh <11854984+soon-teh@users.noreply.github.com> Co-authored-by: Jake Lishman <jake.lishman@ibm.com> Co-authored-by: Shilpa Mahato <61791872+shil-m@users.noreply.github.com> Co-authored-by: Elbert <67720913+elberttl@users.noreply.github.com> Co-authored-by: Bochen "Daniel" Tan <33230390+tbcdebug@users.noreply.github.com> Co-authored-by: Kevin Tian <kt474@cornell.edu> Co-authored-by: Alexander Ivrii <alexi@il.ibm.com> Co-authored-by: rht <rhtbot@protonmail.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
The content is already covered in the current docs, so it wasn't necessary to bring this over in the first place. Closes Qiskit#23.
This issue was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@abbycross @beckykd I'm so lost with these pages pls help 😅
The following files should be migrated from the
qiskit-ibm-runtimerepo to this repo.Files to migrate to docs/start
Files to migrate to docs/build
Files to migrate to docs/test
Files to migrate to docs/run
Files to migrate to docs/optimize
Files to migrate to docs/other
DISCUSS:
The text was updated successfully, but these errors were encountered: