Merge branch 'primitive-examples-isa-circuits' of https://github.com/…

…blakejohnson/qiskit-documentation into primitive-examples-isa-circuits

.github/workflows/extended-checks.yml → .github/workflows/api-checks.yml

@@ -1,6 +1,6 @@
 # This code is a Qiskit project.
 #
-# (C) Copyright IBM 2023.
+# (C) Copyright IBM 2024.
 #
 # This code is licensed under the Apache License, Version 2.0. You may
 # obtain a copy of this license in the LICENSE file in the root directory
@@ -10,14 +10,11 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-# This Action runs checks things that we care about but would be
-# too slow to check in every PR.
-
-name: Extended checks
+name: API checks
 on:
   workflow_dispatch:
   schedule:
-    - cron: "0 0 * * *" # Every day at midnight UTC
+    - cron: "0 0 * * 0,2,4" # Every Sunday, Tuesday, and Thursday at midnight UTC
 
   pull_request:
     paths:
@@ -26,7 +23,7 @@ on:
       - "docs/api/qiskit-ibm-runtime/**/*"
 
 jobs:
-  extended-checks:
+  link-checker:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'Qiskit'
     steps:
@@ -37,8 +34,7 @@ jobs:
           node-version: 18
       - name: Install Node.js dependencies
         run: npm ci
-
-      - name: Check external links
+      - name: Check links
         run: >
           npm run check:links --
           --qiskit-release-notes
@@ -48,15 +44,25 @@ jobs:
           --skip-broken-historical
           --external
 
+  pages-render:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'Qiskit'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install Node.js dependencies
+        run: npm ci
       - name: Start local Docker preview
         run: |
           ./start &
           sleep 20
-        if: ${{ !cancelled() }}
-      - name: Check current API pages render
+      - name: Check API pages render
         run: >
           npm run check-pages-render --
           --qiskit-release-notes
           --current-apis
           --dev-apis
-        if: ${{ !cancelled() }}
+          --historical-apis

.github/workflows/main.yml

@@ -31,12 +31,7 @@ jobs:
       - name: Spellcheck
         run: npm run check:spelling
       - name: Link checker
-        run: >
-          npm run check:links --
-          --current-apis
-          --qiskit-release-notes
-          --historical-apis
-          --skip-broken-historical
+        run: npm run check:links
       - name: Formatting
         run: npm run check:fmt
       - name: Typecheck

README.md

@@ -12,7 +12,7 @@ Read on for more information about how to support this project:
 
 ### 1. Report bugs, inaccuracies or general content issues
 
-This is the quickest, easiest, and most helpful way to contribute to this project and improve the quality of Qiskit and IBM Quantum documentation. There are a few different ways to report issues, depending on where it was found:
+This is the quickest, easiest, and most helpful way to contribute to this project and improve the quality of Qiskit® and IBM Quantum™ documentation. There are a few different ways to report issues, depending on where it was found:
 
 - For problems you've found in the [Qiskit API Reference](https://docs.quantum.ibm.com/api/qiskit) section, open an issue in the Qiskit repo [here](https://github.com/Qiskit/qiskit/issues/new/choose).
 - For problems you've found in the [Qiskit Runtime IBM Client](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime) section, open an issue in the Qiskit IBM Runtime repo [here](https://github.com/Qiskit/qiskit-ibm-runtime/issues/new/choose).
@@ -541,3 +541,32 @@ To display a qasm operation (like a not gate), you can use the `Operation` compo
 ```mdx
 <Operation name="x" />
 ```
+
+## Proper marking and attribution
+
+**All information needs to identify, mark, and attribute IBM and applicable third-party trademarks.** We do this the first time an IBM trademark appears on each page. See the [Copyright and trademark information](https://www.ibm.com/legal/copyright-trademark) page for more details.
+
+Some companies require a special attribution notice. View a list of the companies to include in a special attribution notice at the [Special attributions](https://www.ibm.com/legal/copyright-trademark#special) section of the IBM Legal site.
+
+<details>
+<summary>A (non-exhaustive) list of trademarked names found in our docs:</summary>
+
+- IBM&reg;
+- IBM Cloud&reg;
+- IBM Quantum&trade;
+- Qiskit&reg;
+</details>
+
+See the Usage section of the IBM Quantum Experience Guide for guidance on when to use IBM and when to use IBM Quantum.
+
+### Trademark symbols
+
+To create the symbols in markdown:
+
+Use `&reg;` to get &reg; for registered trademarks.
+
+use `&trade;` to get &trade; for nonregistered trademarks.
+
+<Admonition type="caution">
+  Do not include trademarks in headings. The code will display rather than the symbol.
+</Admonition

docs/api/migration-guides/index.mdx

@@ -6,7 +6,7 @@ description: Migrate to using the newest from Qiskit and Qiskit Runtime
 
 # Introduction
 
-We've prepared various migration guides to help you more effectively use Qiskit and Qiskit Runtime:
+We've prepared various migration guides to help you more effectively use Qiskit® and Qiskit Runtime:
 
 * Migrate to Qiskit Runtime
    * [How to migrate](./qiskit-runtime)
@@ -15,4 +15,4 @@ We've prepared various migration guides to help you more effectively use Qiskit
 * Qiskit 0.44 changes
    * [`qiskit.algorithms` new interface](./qiskit-algorithms-module)
    * [`qiskit.opflow` deprecation](./qiskit-opflow-module)
-   * [`QuantumIntance` deprecation](./qiskit-quantum-instance)
+   * [`QuantumInstance` deprecation](./qiskit-quantum-instance)

docs/api/migration-guides/qiskit-1.0.mdx

@@ -5,7 +5,7 @@ description: Adapt to changes in installing and depending on Qiskit 1.0
 
 # Qiskit 1.0 packaging changes
 
-Qiskit 1.0 uses a different packaging structure than previous Qiskit versions and might cause problems in environments that use packages that are not ready for Qiskit 1.0.
+Qiskit® 1.0 uses a different packaging structure than previous Qiskit versions and might cause problems in environments that use packages that are not ready for Qiskit 1.0.
 
 <Admonition type="caution">
 Do not try to upgrade an existing Python virtual environment to Qiskit 1.0 in-place.
@@ -397,7 +397,7 @@ Further complications aren't necessary to understand the problems described in t
 
 ### The old Qiskit structure
 
-Historically, Qiskit was comprised of many Python distributions: `qiskit-terra`, the compiler core; `qiskit-aer`, the high-performance simulator; the original IBM Quantum provider; and several now-obsolete packages providing particular exploratory algorithmic or experiment-running features.
+Historically, Qiskit was comprised of many Python distributions: `qiskit-terra`, the compiler core; `qiskit-aer`, the high-performance simulator; the original IBM Quantum&trade; provider; and several now-obsolete packages providing particular exploratory algorithmic or experiment-running features.
 For user ease, we also provided a Python distribution called `qiskit`, which contained no code of its own, but caused all the other components to be installed.
 We called this the _metapackage_, by analogy to similar concepts in other package managers.
 The code of the core of Qiskit lived in `qiskit-terra`, which owned the root of the Python package `qiskit`. In other words, `qiskit-terra` controlled what happened when you ran `import qiskit`.
@@ -467,7 +467,7 @@ Exit Jupyter, activate the Qiskit virtual environment on the command line, run `
 
 ### `import qiskit` succeeds, but trying to do anything returns "AttributeError: module 'qiskit' has no attribute '...'"
 
-This likely means that your environment had an old version of Qiskit in it alongside a package that extended its namespace (such as old versions of Qiskit Aer, or the long-obsolete Qiskit IBMQ Provider), and then Qiskit was uninstalled.
+This likely means that your environment had an old version of Qiskit in it alongside a package that extended its namespace (such as old versions of Qiskit Aer, or the long-obsolete Qiskit IBM Q&reg; Provider), and then Qiskit was uninstalled.
 The easiest thing to do is to start a new virtual environment, and only install recent, non-obsolete packages into it.
 
 If you have just started a new virtual environment, or you're sure that legacy packages are not the problem, make sure that your current working directory (the directory your shell session was in when you launched Python / Jupyter) does not contain a folder called `qiskit`.

docs/api/migration-guides/qiskit-algorithms-module.mdx

@@ -5,7 +5,7 @@ description: Use the new interface for `qiskit.algorithms`
 
 # Algorithms migration guide
 
-  In Qiskit 0.44 and later releases, the `qiskit.algorithms` module has been superseded by a new standalone library, `qiskit_algorithms`,
+  In Qiskit® 0.44 and later releases, the `qiskit.algorithms` module has been superseded by a new standalone library, `qiskit_algorithms`,
   available on [GitHub](https://github.com/qiskit-community/qiskit-algorithms) and 
   [PyPi](https://pypi.org/project/qiskit-algorithms). The `qiskit.algorithms` module  was migrated to a
   separate package in order to clarify the purpose of Qiskit and make a distinction between the tools and libraries built on top of it.
@@ -86,7 +86,7 @@ Once you know which primitive you want to use, choose the primitive implementati
 
 * For running on quantum hardware choose from these options:
 
-   - Access services with native primitive implementations, such as the IBM Qiskit Runtime service by using [`qiskit_ibm_runtime.Sampler`](../qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) and [`qiskit_ibm_runtime.Estimator`.](../qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)
+   - Access services with native primitive implementations, such as the Qiskit Runtime service by using [`qiskit_ibm_runtime.Sampler`](../qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) and [`qiskit_ibm_runtime.Estimator`.](../qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)
    - Wrap any system with `Backend` primitives ([`qiskit.primitives.BackendSampler`](../qiskit/qiskit.primitives.BackendSampler) and [`qiskit.primitives.BackendEstimator`](../qiskit/qiskit.primitives.BackendEstimator)). These wrappers implement a primitive interface on top of a backend that only supports `backend.run()`.
 
 For detailed information and examples, particularly on the use of the `Backend` primitives, refer to