Migrate open source docs

[Eric-Arellano]

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, 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:

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()

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
19 out of 24 committers have signed the CLA.

✅ NG-Glen
✅ frankharkins
✅ ElePT
✅ SooluThomas
✅ mtreinish
✅ Guillermo-Mijares-Vilarino
✅ beckykd
✅ 1ucian0
✅ wshanks
✅ EmilMagni
✅ divshacker
✅ WhiteSymmetry
✅ shil-m
✅ Eric-Arellano
✅ elberttl
✅ jakelishman
✅ Cryoris
✅ jyu00
✅ rht
❌ filippotramonto
❌ king-p3nguin
❌ Ikko Eltociear Ashimine
❌ 3yakuya
❌ soon-teh

---

Ikko Eltociear Ashimine seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[Eric-Arellano]

The CLA checker is not correctly identifying that @elberttl has already signed the CLA in Qiskit/qiskit-tutorials#1231. The email 67720913+elberttl@users.noreply.github.com is the same in this PR as in qiskit-tutorials and when we merged qiskit-tutorials into qiskit; the CLA worked correctly with the qiskit merge, so I'm not sure what's going on.

@elberttl, if you're around, it'd be helpful to please follow this link https://cla-assistant.io/Qiskit/documentation?pullRequest=91. But we should be fine either way since the CLA is for the entire Qiskit organization and it has already been signed.

[frankharkins]

The script is good and the history looks reasonable; nice job :)

[Eric-Arellano]

FYI I force pushed an update because I realized I left off the original names for some of the tutorials.

I've confirmed that the below contributors signed the CLA. The CLA tool is only not working properly. For @elberttl, it looks like it took some time for the CLA tool to pick up the name.

For some of these, you have to click "View details" on the merge commit to see that the CLI check passed:

• king-p3nguin Deleted unused import qiskit-tutorials#1374
• filippotramonto Small fixes of 1_getting_started_with_qiskit.ipynb qiskit-tutorials#1383
• eltociear Fix typo in 01_circuit_basics.ipynb qiskit-tutorials#1474
• 3yakuya Minor improvements to Getting Started tutorials. qiskit-tutorials#926 (comment)
• soon-teh fix missing backticks for plot_histogram() qiskit-tutorials#1480

So, we should be good to go. Merging.