Qiskit / Qiskit/documentation

Stop using external links to IQP

Open
#3,663 0 comments 0 reactions 1 assignee View on GitHub

@GantaRoja is already working on this.

Since Sep 26, 2025.

infra 🏗️ tech debt 💩
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

Thanks to changes made in the internal app, we no longer need to use https://quantum.cloud.ibm.com. We can now use absolute links like / (homepage), /functions, etc. The web app will correctly understand this belongs to the Platform app and not our Docs app.

Fixing this has some benefits:

However, note that it's not 100% necessary. The web app will already convert https://quantum.cloud.ibm.com to https://eu-de.quantum.cloud.ibm.com for us.

Part 1: update our docs

Fix all instances of rg 'quantum.cloud.ibm.com' docs learning. Be very careful to only update links and not actual text. Don't update API docs

You will need to make sure that the link checker is passing. It probably won't naively. Run npm run check:internal-links. If there are failures, you will need to update this list so that our link checker thinks the files exist:

https://github.com/Qiskit/documentation/blob/e12ef6299015fd928cbf9bb370ebdd46232e8559/scripts/js/commands/checkInternalLinks.ts#L26

Part 2: update API docs

Rework relativizeLink in scripts/js/lib/api/updateLinks.ts, which is used to update our API docs to use the proper links for our app. It would only update Docs links before, but should probably update all links to https://quantum.cloud.ibm.com.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.