Merge branch 'Qiskit:main' into main

Author: shraddha-aangiras

.github/ISSUE_TEMPLATE/bug.yaml

@@ -1,10 +1,9 @@
-name: 🪲 Content bug or inaccuracy
+name: 🪲 Content bug or inaccuracy with non-API docs
 description: Report typos, bugs, out-of-date content, broken links, etc.
 labels: ["bug 🐛", "content 📄"]
 assignees:
   - abbycross
   - beckykd
-  - javabster
 
 body:
   - type: markdown

.github/ISSUE_TEMPLATE/config.yml

@@ -6,9 +6,9 @@ contact_links:
   - name: Overall impressions and feedback
     url: https://ibmxm.iad1.qualtrics.com/jfe/form/SV_7Uq9FCMjZPyTsFM?Q_PopulateResponse={%22QID20%22:%223%22}
     about: Let us know what you think! Provide feedback to help us improve your documentation experience.
-  - name: Qiskit API feedback
+  - name: 🪲 Content bug or inaccuracy with docs.quantum.ibm.com/api/qiskit
     url: https://github.com/Qiskit/qiskit/issues/new/choose
     about: Open an issue in the Qiskit repository for the docs found at https://docs.quantum.ibm.com/api/qiskit.
-  - name: Qiskit Runtime Client API feedback
+  - name: 🪲 Content bug or inaccuracy with docs.quantum.ibm.com/api/qiskit-runtime
     url: https://github.com/Qiskit/qiskit-ibm-runtime/issues/new/choose
     about: Open an issue in the qiskit-ibm-runtime repository for the docs found at https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/runtime_service.

.github/workflows/main.yml

@@ -32,6 +32,8 @@ jobs:
         run: npm run check:spelling
       - name: Check Qiskit bot config
         run: npm run check:qiskit-bot
+      - name: Check Patterns index
+        run: npm run check:patterns-index
       - name: Internal link checker
         run: npm run check:internal-links
       - name: Check orphaned pages

.github/workflows/notebook-test-cron.yml

@@ -40,6 +40,26 @@ jobs:
           git diff --name-only >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
 
+      - name: Make pull request with notebook outputs
+        if: "!cancelled()"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+          git switch -c actions/cron-${{ github.run_id }}
+          git commit -am "Re-run notebooks"
+          git push origin actions/cron-${{ github.run_id }}
+          gh pr create \
+           -B main \
+           -H actions/cron-${{ github.run_id }} \
+           --title "Update notebook outputs" \
+           --body "An action recently executed the notebooks in this repo. \
+            This PR updates all notebooks that ran successfully with the new cell outputs.
+            > [!NOTE]
+            > This pull request was created by a GitHub action." \
+           --reviewer frankharkins
+
       - name: Upload executed notebooks
         if: "!cancelled()"
         uses: actions/upload-artifact@v4

.github/workflows/notebook-test.yml

@@ -56,6 +56,11 @@ jobs:
         with:
           # Add your notebook to this list if it needs latex or graphviz to run
           files: |
+            docs/guides/visualize-circuits.ipynb
+            docs/guides/custom-backend.ipynb
+            docs/guides/transpiler-stages.ipynb
+            docs/guides/represent-quantum-computers.ipynb
+            docs/guides/common-parameters.ipynb
             docs/build/circuit-visualization.ipynb
             docs/build-new/circuit-visualization.ipynb
             docs/transpile/common-parameters.ipynb

.github/workflows/preview-docs-teardown.yml

@@ -0,0 +1,50 @@
+# This code is a Qiskit project.
+#
+# (C) Copyright IBM 2023.
+#
+# 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
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+# WARNING: This event type uses secrets even when triggered by an untrusted PR.
+# Do NOT checkout the PR or access any user-defined inputs (such as the title) as it could be untrusted.
+# For more information, see https://securitylab.github.com/research/github-actions-preventing-pwn-requests/.
+# This event type runs on the target branch (rather than a merge commit of the
+# target and PR branches), so you'll need to test it out in a fork.
+
+name: Preview teardown
+
+on:
+  pull_request_target:
+    types: [closed]
+    paths:
+      - "docs/**/*"
+      - "public/images/**/*"
+
+jobs:
+  teardown:
+    # Do not edit or modify the repo name condition; see warning above
+    if: |
+      github.event.action == 'closed' &&
+      github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/set-up-ibm-cloud
+        id: set-up-cloud
+        with:
+          env_name: Preview
+          ibmcloud_account: ${{ secrets.IBMCLOUD_ACCOUNT }}
+          ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
+      - name: Remove Code Engine preview application
+        run: |
+          ibmcloud ce project select -n qiskit-docs-preview
+          ibmcloud ce application delete \
+            --name "${{ steps.set-up-cloud.outputs.app_name }}" \
+            --wait \
+            --ignore-not-found \
+            --force

.github/workflows/preview-docs.yml

@@ -20,7 +20,7 @@ name: Preview
 
 on:
   pull_request:
-    types: [opened, reopened, synchronize, closed]
+    types: [opened, reopened, synchronize]
     paths:
       - "docs/**/*"
       - "public/images/**/*"
@@ -36,25 +36,3 @@ jobs:
     secrets:
       ibmcloud_account: ${{ secrets.IBMCLOUD_ACCOUNT }}
       ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
-
-  teardown:
-    if: |
-      github.event.action == 'closed' &&
-      github.event.pull_request.head.repo.full_name == github.repository
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ./.github/actions/set-up-ibm-cloud
-        id: set-up-cloud
-        with:
-          env_name: Preview
-          ibmcloud_account: ${{ secrets.IBMCLOUD_ACCOUNT }}
-          ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
-      - name: Remove Code Engine preview application
-        run: |
-          ibmcloud ce project select -n qiskit-docs-preview
-          ibmcloud ce application delete \
-            --name "${{ steps.set-up-cloud.outputs.app_name }}" \
-            --wait \
-            --ignore-not-found \
-            --force

Dockerfile

@@ -31,10 +31,10 @@
 #   2. ❯ docker run --rm -p 3000:3000 -t qiskit-docs-preview
 #   3. Open up http://localhost:3000
 
-FROM icr.io/quantum-computing/iqp-channel-docs-dev:latest
+FROM icr.io/quantum-computing/iqp-channel-docs-dev:open-source
 
 COPY docs/ /home/node/app/docs
 COPY translations/ /home/node/app/docs
-COPY public/ /home/node/app/packages/web/public/
+COPY public/ /home/node/app/packages/preview/public/
 
 EXPOSE 3000 5001

README.md

@@ -436,15 +436,15 @@ The add the following to your `.gitconfig` (usually found at `~/.gitconfig`).
 
 This content lives on https://docs.quantum.ibm.com.
 
-See https://github.ibm.com/IBM-Q-Software/iqp-channel-docs#syncing-content-with-open-source-repo.
+See the section "Syncing content with open source repo" in the internal docs repo's README.
 
 ### Deploy tutorials
 
 This content lives on https://learning.quantum.ibm.com.
 
 To deploy a file from the `tutorials/` directory in this repository, see the instructions in the [tutorials directory README](https://github.com/Qiskit/documentation/blob/main/tutorials/README.md).
 
-To deploy a file from the ibm-quantum-learning-enablement repository, see the instructions in that repo's [tutorials directory README](https://github.ibm.com/IBM-Q-Software/ibm-quantum-learning-enablement/blob/main/tutorials/README.md).
+To deploy a file from the ibm-quantum-learning-enablement repository, see the instructions in the internal tutorial repo's tutorials directory README.
 
 # How to write the documentation
 

cspell/dictionaries/qiskit.txt

@@ -159,4 +159,7 @@ simulable
 resynthesizes
 sdist"
 transpiling
+mthree
+Algorithmiq
+unphysical