Skip to content

Commit

Permalink
Audited qiskit.org links (#381)
Browse files Browse the repository at this point in the history
This PR replaces any qiskit.org links with 1XP or github equivalents.
Need to wait to merge until I can update the deprecation policy and
maintainer guide links after
Qiskit/qiskit#11218 merges.

This should partially resolve #297 , however for the api links we'll
need to make updates for those directly in the repos where the API refs
live (maybe this is beyond the scope of the original issue?)

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
  • Loading branch information
javabster and Eric-Arellano authored Nov 22, 2023
1 parent ddbb8c0 commit ca4f0dd
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Qiskit docs

The documentation content home for https://docs.quantum-computing.ibm.com. Note this repo does not contain content for https://learning.quantum-computing.ibm.com/ or https://qiskit.org. Refer to https://github.com/Qiskit/qiskit to make changes to the docs at https://qiskit.org/documentation.
The documentation content home for https://docs.quantum-computing.ibm.com (excluding API reference).

# Improving IBM Quantum & Qiskit Documentation

Expand Down Expand Up @@ -173,7 +173,7 @@ To check that formatting is valid without actually making changes, run `npm run
## Regenerate the API docs

1. Choose which documentation you want to regenerate: `qiskit`, `qiskit-ibm-provider`, or `qiskit-ibm-runtime`
2. Determine the current version of the published stable documentation, e.g. at https://qiskit.org/documentation/
2. Determine the current version of the published stable documentation, e.g. at https://github.com/Qiskit/qiskit/releases
3. Run `npm run gen-api -- -p <pkg-name> -v <version>`, e.g. `npm run gen-api -- -p qiskit -v 0.45.0`

For `qiskit`, you can also regenerate historical versions by adding `--historical` to the arguments. This is useful when we improve our generation script.
3 changes: 1 addition & 2 deletions docs/api/migration-guides/qiskit-runtime.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ level.

The Qiskit Runtime primitives implement the reference `Sampler` and
`Estimator` interfaces found in
[qiskit.primitives](https://qiskit.org/documentation/apidoc/primitives.html).
[qiskit.primitives](../qiskit/primitives).
These interfaces let you switch between primitive implementations with
minimal code changes. Different primitive implementations can be found
in the `qiskit`, `qiskit_aer`, and `qiskit_ibm_runtime` libraries. Each
Expand Down Expand Up @@ -470,7 +470,6 @@ an algorithm, you might want to tune certain primitive options. For details, see
- [Get started with Sampler.](../../run/primitives-get-started#start-sampler)
- Explore [sessions.](../../run/sessions)
- [Run a primitive in a session.](../../run/run-jobs-in-session)
- Experiment with the [migration tutorial.](https://qiskit.org/ecosystem/ibm-provider/tutorials/Migration_Guide_from_qiskit-ibmq-provider.html)
- Experiment with the [Run custom transpiled circuits with primitives tutorial.](https://learning.quantum-computing.ibm.com/tutorial/submitting-user-transpiled-circuits-using-primitives)

</Admonition>
8 changes: 4 additions & 4 deletions docs/support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ For help with Qiskit, access our Slack community: [Qiskit Slack](https://qisk.it

The following pages are resources for anyone interested in contributing code to Qiskit.

- [Code of conduct](https://github.com/Qiskit/qiskit-metapackage/blob/master/CODE_OF_CONDUCT.md)
- [Contributing guide](https://qiskit.org/documentation/contributing_to_qiskit.html#contributing-links)
- [Deprecation policy](https://qiskit.org/documentation/deprecation_policy.html)
- [Maintainers guide](https://qiskit.org/documentation/maintainers_guide.html)
- [Code of conduct](https://github.com/Qiskit/qiskit/blob/main/CODE_OF_CONDUCT.md)
- [Contributing guide](https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md)
- [Deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md)
- [Maintainers guide](https://github.com/Qiskit/qiskit/blob/main/MAINTAINING.md)

## Other discussions

Expand Down

0 comments on commit ca4f0dd

Please sign in to comment.