-
Notifications
You must be signed in to change notification settings - Fork 163
Fix outdated links #4506
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Fix outdated links #4506
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
One or more of the following people are relevant to this code: |
frankharkins
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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", |
Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
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 |
|
@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. |
Related to #4336