Fix outdated links

[beckykd]

Related to #4336

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[qiskit-bot]

One or more of the following people are relevant to this code:

• @abbycross
• @johannesgreiner
• @manuelmartin3
• @pandasa123

[frankharkins]

Thank you!

For the links in the API docs, we'll need to add the redirects to scripts/config/external-redirects.ts, otherwise these changes will be discarded when we next regenerate the docs from source.

The format is:

"old":
  "new",

E.g.

documentation/scripts/config/external-redirects.ts

Lines 38 to 39 in 2140419

	"https://aip.scitation.org/doi/10.1063/1.5141835":
	"https://pubs.aip.org/aip/jcp/article/152/12/124107/953761/Quantum-orbital-optimized-unitary-coupled-cluster",

[beckykd]

we'll need to add the redirects

Even though the changes will be made in the API docs themselves?

[frankharkins]

Even though the changes will be made in the API docs themselves?

Yep: We store the original API docs HTML in Box and sometimes re-run the HTML -> markdown pipeline to fix bugs. When this happens, your fixes will be overwritten by the pipeline with the original links. The external-redirects.ts tells the pipeline to do the same link substitution that you've done in this PR.

[beckykd]

@frankharkins what should we do about links that are broken in historical API documents but don't exist in more recent documents? For example, qaiskit-ibm-runtime/0.40/qiskit-runtime-service links to https://auth.quantum.ibm.com/api. That API no longer exists and the link was just deleted from the later versions.

[beckykd]

These are the changes being made in the API file:

https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json -> https://quantum.cloud.ibm.com/docs/api/qiskit-runtime-rest/tags/backends#tags__backends__operations__get_backend_configuration

https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_properties_schema.json -> https://quantum.cloud.ibm.com/docs/api/qiskit-runtime-rest/tags/backends#tags__backends__operations__get_backend_configuration

https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json -> DELETED

[arnaucasau]

Thanks for working on this, Becky!!

[arnaucasau]

This link needs to be fixed in the runtime repo (main branch and stable/0.45):

• https://github.com/Qiskit/qiskit-ibm-runtime/blob/ce9f35518e35f6ca18ed85471b993ee6326b1f9c/release-notes/0.32.0.rst?plain=1#L47
• https://github.com/Qiskit/qiskit-ibm-runtime/blob/ce9f35518e35f6ca18ed85471b993ee6326b1f9c/release-notes/0.30.0.rst?plain=1#L18

[frankharkins]

@frankharkins what should we do about links that are broken in historical API documents but don't exist in more recent documents? For example, qaiskit-ibm-runtime/0.40/qiskit-runtime-service links to https://auth.quantum.ibm.com/api. That API no longer exists and the link was just deleted from the later versions.

I think if a link has no replacement, it's OK for it to be broken in a historical version. These are archives after all and it might even be helpful for a user to know that the API isn't available any more.

Maybe just update the comment to explain we're not going to fix them.

[beckykd]

These are the changes being made in the API file:

I updated the comment in the Ignore.ts file to explain why we're leaving the links that don't have a replacement as-is in the old API docs. I also added the redirects listed to the external-redirects file.