Commit Graph

1103 Commits

Author SHA1 Message Date
Eric Arellano 3548427f09 Generate Runtime 0.25 docs (#1656) 2024-07-04 17:35:35 +00:00
Eric Arellano 37f38d4570 Fix Qiskit Bot not checking migration guides (#1646)
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
2024-07-04 17:35:22 +00:00
Eric Arellano e8d3efa5a0 Remove README entry about Composer component (#1655)
This component is unused and being removed.
2024-07-04 14:40:14 +00:00
Arnau Casau 405917f9b7 Complete guides reorg To-Do (#1653)
This PR finishes with all the To-Do we had from the guides reorg
2024-07-04 13:18:58 +00:00
Rebecca Dimock 810ff1b8d8 Deprecation of WebSocket endpoints (#1625)
closes #1622

---------

Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-07-03 15:32:49 -04:00
abbycross a35ef07c95 Add r2 to Heron entry in processor-types file (#1648)
Text from the hardware team:



    HeronR2:

This is a revision of our original Heron processor. The chip has been
redesigned to now include 156 qubits in a heavy-hexagonal lattice. While
continuing to make use of the innovations of the original Heron systems,
it also introduces a new TLS mitigation feature that controls the TLS
environment of the chip, thereby improving coherence and stability
across the whole chip.

---------

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
2024-07-03 14:54:38 -04:00
Eric Arellano 8d3fdafa04 Don't use "system" with docs reorg (#1647)
We'll update the redirect rules in closed source.

The page content will be updated in a follow up. For now, we need to get
the URLs and left ToC right to unblock the migration.

---------

Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>
2024-07-02 15:50:08 -04:00
Eric Arellano cfeeb72e2f Fix ToC title in guides reorg (#1636) 2024-07-02 12:18:27 -04:00
Eric Arellano 9a68dc18d8 Update SVGs for patterns (#1635) 2024-07-02 12:11:55 -04:00
Abby Mitchell a2a9638933 Switched nature for qbraid in ecosystem intro (#1634) 2024-07-02 11:51:42 -04:00
Arnau Casau 14656154f6 Docs reorganization: Guides (#1631)
This PR adds the new `guides/` folder with all the new docs, updates the
qiskit bot config, and removes the old folders `start/`, `build/`,
`transpiler/`, `verify/`, and `run/`

Commands used:
```bash
./scripts/patterns-reorg/update_internal_links.py
./scripts/patterns-reorg/update_qiskit_bot.py
./scripts/patterns-reorg/main.py --delete-existing
npm run fmt
```
2024-07-02 11:17:38 -04:00
Arnau Casau e4bf9d7684 Rewrite migration-guides whitespaces (#1632)
Prework of https://github.com/Qiskit/documentation/pull/1631.

This PR rewrites the files `qiskit-runtime-examples.mdx` and
`qiskit-runtime.mdx` to reduce the git diff of #1631
2024-07-02 11:09:07 -04:00
Arnau Casau e095d04409 Fix custom-transpiler-pass notebook (#1633)
The `custom-transpiler-pass.ipynb` notebook was using a
[deprecated](https://numpy.org/devdocs/release/1.25.0-notes.html#deprecations)
numpy function called `alltrue`. This PR changes the notebook to use
instead the function `all`.

In this
[CI](https://github.com/Qiskit/documentation/actions/runs/9762810433/job/26947134720?pr=1631)
run you can find the notebook failing because of the deprecation.
2024-07-02 11:00:42 -04:00
Arnau Casau 2b116d85f2 Fix patterns scripts (#1630)
This PR fixes our scripts to update the qiskit bot config file and the
validation script for the pattern index pages
2024-07-02 14:15:00 +00:00
Eric Arellano 45e4dbc643 Tweak redirects for runtime options pages (#1626)
Prep for https://github.com/Qiskit/documentation/pull/1499. 

* `/configure-runtime-compilation` will become
`/configure-error-suppression`.
* `/advanced-runtime-options` is being deleted and replaced with
`/runtime-options-overview`, which isn't necessarily the same content.
Still, it costs us nothing to do a redirect; it avoids a 404 for users
and keeps our SEO we've built up for the page.

I didn't update the page titles yet, which will be done in
https://github.com/Qiskit/documentation/pull/1499. We only need to get
the URLs right here because those are hard to change.
2024-07-01 18:47:11 +00:00
Arnau Casau 0f7c280f22 Remove the right ToC from the patterns Intro page (#1614)
This PR sets `in_page_toc_show` to `false` to the front matter of the
patterns Intro page in order to remove the right ToC.
2024-06-28 13:10:59 +00:00
Arnau Casau 795135727b Update SVGs for patterns pages (#1606)
This PR updates the SVGs for the patterns pages.
2024-06-27 16:56:03 +00:00
Arnau Casau b74c5174ab Fix `update_internal_links` script (#1605)
This PR fixes the `update_internal_links.py` script that was broken
because we changed the `redirects.json` file to have a different style.
2024-06-27 16:56:00 +00:00
Arnau Casau 5974f70e21 Fix broken link (#1604)
This PR fixes a broken link in the intro-to-patterns page
2024-06-27 16:15:24 +00:00
abbycross 96c3157061 update the latest updates page (#1596)
bring in the latest blog and the newest docs updates. 
Also closes https://github.com/Qiskit/documentation/issues/1597 to use
reverse chronological order for the Runtime service updates.
2024-06-27 15:08:12 +00:00
Arnau Casau 679617cc5d Organize guides images (#1600)
Part of #154

This PR, following the idea of this
[comment](https://github.com/Qiskit/documentation/issues/154#issuecomment-2104751884),
moves all the images in the folders `start`, `build`, `transpile`,
`verify`, and `run` to a new folder called `guides`, updating all the
docs to point to that new folder.

To change the links, I used the following script that updates all but 3
links that are missed by the regex. I changed them manually.

<details>
<summary>Script</summary>

```python
from __future__ import annotations
import re
import glob
from pathlib import Path
from main import OLD_FOLDERS

def update_link(markdown: str, image_folder: str, link: str) -> str:
    new_link = link.replace(f"/images/{image_folder}/", "/images/guides/")
    return markdown.replace(link, new_link)

def main() -> None:
    inline_link_re = re.compile(r"\!\[([^\]]+)\]\(([^)]+)\)")

    for folder in [*OLD_FOLDERS, "api/migration-guides"]:
        image_folder = folder if folder != "api/migration-guides" else "run"
        for file_path in glob.glob(f"docs/{folder}/*"):
            file = Path(file_path)
            markdown = file.read_text()
            new_markdown = re.sub(
                inline_link_re,
                lambda m: update_link(m[0], image_folder, m[2]),
                markdown,
            )
            if markdown != new_markdown:
                file.write_text(new_markdown)

if __name__ == "__main__":
    main()
```
</details>
2024-06-27 14:55:39 +00:00
Eric Arellano 6c4332c4b8 Remove PR previews for now (#1595)
Part of https://github.com/Qiskit/documentation/issues/1043. Code Engine
is shut down tomorrow, so we need to turn off previews for now.

We're still working on what the replacement is. Once that's ready, we'll
revive whichever of these files are relevant.
2024-06-26 19:26:03 +00:00
Arnau Casau 7a3029dab2 Update patterns redirects file (#1594)
The PR updates the `scripts/patterns-reorg/redirects.json` file to a
more convenient format that aligns better with our middleware. Having
the `/` at the beginning of the old paths and the `/guides/` prefix in
the new paths will allow us to have a more generic redirect file that
could be used in the future for different URLs than patterns, and it
will help us to set the redirects with a simpler logic.

e.g., `url.pathname = REDIRECTS[url.pathname]`

The PR also adds a missing redirect for `/start/latest-updates`.
2024-06-26 19:24:39 +00:00
Eric Arellano 14c0363958 Use new Docker image for previews (#1590)
We removed the remote refresh mechanism from the previews, so port 5001
is no longer relevant.

We also can now use the Dockerhub image for both `./start` and IBM Code
Engine PR previews, so we can be consistent and stop using the IBM
Container Registry version. That simplifies our infra.
2024-06-25 18:18:53 +00:00
Abby Mitchell a6c184d45b removed toqm from intro to qiskit page (#1582)
Removed Qiskit TOQM item from the intro to qiskit page as it is no
longer part of the qiskit ecosystem
2024-06-24 19:42:16 +00:00
Frank Harkins 936138ec10 Add "Latest updates" page (#1411)
Adds a latest updates page with some initial content. Closes #1301.

I've prioritised news that requires user action (i.e. deprecations), but
open to other ideas too.

Points from a recent meeting:
- We will want product owners to write a release summary for each
release - and specify that the url out to the release notes should
specify the version (this is mentioned in the Docs overview and
publishing processes page)
- Highlight product blogs, product announcements, and latest versions of
each API ref release
- Duplicate "what's new in the docs" from the announcements

---------

Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Co-authored-by: ABBY CROSS <across@us.ibm.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-06-24 17:07:27 +00:00
abbycross 7100b1981d Mention the need for the graphviz library on transpile/custom-backend page (#1558)
Closes #1394
2024-06-24 15:15:10 +00:00
Frank Harkins 85236624f1 Update redirected links (#1589)
Fixes part of #1588. The other two will need to be fixed in the Qiskit
source or HTML arifacts.
2024-06-24 11:14:30 +00:00
Arnau Casau 640016500e Fix incomplete sentence for preset_passmanagers (#1581)
Part of https://github.com/Qiskit/documentation/issues/1534

This PR fixes the incomplete sentence for the
generate_preset_pass_manager method for the historical versions of
qiskit 0.37, 0.38, 0.39, 0.40, 0.41, 0.42, 0.43, 0.44, 0.45, 0.46, 1.0,
and 1.1.
2024-06-21 13:42:42 +00:00
Luciano Bello 977123f1d7 tt in `configure-qiskit-local` (#1430)
There are some very small formatting issues in
https://docs.quantum.ibm.com/start/configure-qiskit-local . Nothing
terrible, it was just easy to fix than to report them.

![Screenshot 2024-05-27 at 13 51
06](https://github.com/Qiskit/documentation/assets/766693/d4363a4a-cc45-43bb-b165-c9a438fb0066)

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-06-21 13:00:20 +00:00
Eric Arellano 6af8296af6 Regen Qiskit 0.46, 1.1, 1.2-dev; Runtime 0.24, 0.25-dev (#1583)
```
npm run gen-api -- -p qiskit -v 0.46.2 --historical 
npm run gen-api -- -p qiskit -v 1.1.1 
npm run gen-api -- -p qiskit -v 1.2.0-dev --dev 
npm run gen-api -- -p qiskit-ibm-runtime -v 0.24.1 
npm run gen-api -- -p qiskit-ibm-runtime -v 0.25.0-dev --dev
```
2024-06-21 10:57:47 +00:00
Frank Harkins 91500802ea Update code for runtime 0.24.1 (#1580)
This PR bumps the `qiskit_ibm_runtime` version to the most recent, and
updates our code examples to work with that version.

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-06-20 16:46:06 +00:00
Abby Mitchell 9223038c27 Last updates to Intro to Qiskit and what are patterns pages (#1507)
Just added some images and did some reformatting

---------

Co-authored-by: abbycross <across@us.ibm.com>
2024-06-20 14:22:14 +00:00
Frank Harkins ba566bb998 Make code example in "save-jobs" more robust (#1578)
This code example fails in our tests if the most recent job is
cancelled. This PR filters by job status to avoid that.
2024-06-20 09:20:54 +00:00
abbycross 53e8bde652 Edits to operators pages (#1574)
Noticed a few edits to make in a [recent closed
PR](https://github.com/Qiskit/documentation/pull/1517).

- Changed "we" to "you"
- avoided "will" when appropriate
- replaced "may" with either "can" or "might" depending on context
- general typo/punctuation/capitalization cleanup
2024-06-19 15:58:59 +00:00
Arnau Casau 45111f70c8 Add patterns index validation (#1550)
Closes https://github.com/Qiskit/documentation/issues/1299

This PR adds a script that validates that every page shows up both in
the Tools folders and in the Workflow index pages.

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-06-19 13:02:45 +00:00
Arujjwal Negi c18a06d3a6 Added clarification regarding job mode in V2 (#1562)
Closes #1486

added a note at https://docs.quantum.ibm.com/run/run-jobs-batch

---------

Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
2024-06-19 12:42:09 +00:00
Eric Arellano 57bae8ec9e Add three new pages to docs migration (#1494)
This is a new file since we came up with the original docs migration
plan.

<details><summary>circuit-execution left ToC</summary>

<img width="268" alt="Screenshot 2024-06-04 at 1 02 20 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/25d74746-e1df-4687-9155-450a2c418000">
</details>

<details><summary>circuit-execution patterns index page</summary>

<img width="440" alt="Screenshot 2024-06-04 at 1 03 00 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/97ab4324-a263-41ac-b4a3-48760e048878">
</details>


<details><summary>operator-class left ToC</summary>

<img width="258" alt="Screenshot 2024-06-18 at 1 57 36 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/c96df34b-e3b3-4a0a-b847-d70286239d72">
</details>

<details><summary>operator-class patterns index page</summary>
<img width="424" alt="Screenshot 2024-06-18 at 1 54 50 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/9cd034ca-463a-4fa9-87dc-b94791922abe">

</details>


<details><summary>error-mitigation-and-suppression-techniques left
ToC</summary>

<img width="260" alt="Screenshot 2024-06-18 at 1 57 11 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/e6d0c74e-6ca2-4263-a592-a797cc8acec8">
</details>


<details><summary>error-mitigation-and-suppression-techniques patterns
index page</summary>

<img width="398" alt="Screenshot 2024-06-18 at 1 56 47 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/c4f13b5c-7177-4f01-b6a3-374613aaf809">
</details>
2024-06-18 21:10:17 +00:00
Eric Arellano b67d20f5c1 Fix images in PR previews (#1572)
Closes https://github.com/Qiskit/documentation/issues/1551.
2024-06-18 16:21:37 -04:00
abbycross 0a654798c3 rename issue templates to be clearer (#1556)
Closes #1554 

Removing Abby M as an automatic assignee from bug reports too.

After the docs reorg, can reword the title of the bug issue for Platform
docs by indicating it's for anything in the /guides/ directory.

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-06-18 16:43:24 +00:00
abbycross 62495f181c Add in "suppression" to error mitigation pg title to make more accurate (#1570)
Closes #1569
2024-06-18 16:41:31 +00:00
abbycross 1791639cd4 Update broken threading code in Run-jobs-in-session (#1571)
Closes #1568
2024-06-17 20:39:51 +00:00
Kaelyn Ferris 249eb0a18a Update "operators overview" page to highlight SparsePauliOp and split in-depth Operator coverage to separate page (#1517)
Closes #1440 

@kevinsung, here's what I have so far in terms of content to include. I
think it might be worth mentioning the overloaded operators for the
`SparsePauliOp` class and demonstrate some of the algebra that can be
done.

---------

Co-authored-by: Kevin J. Sung <kevjsung@umich.edu>
2024-06-17 18:40:56 +00:00
Kevin J. Sung 782ac73df0 Show how to generate built-in transpiler stage (#1546)
Fixes #1044 .
2024-06-17 17:03:40 +00:00
abbycross dd8a7c9efc Add instructions to delete account and account data (#1557)
Closes #1504.

---------

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
2024-06-14 20:31:44 +00:00
Kaelyn Ferris 02c4fe8eac Explain why decompose is used (#1513)
Closes #1439 
 
Decompose is basically only used here to visualize the circuit
correctly. If it wasn't, it just be an opaque block when calling
`draw()`
2024-06-14 19:38:35 +00:00
Arnau Casau c7e2a8b3f8 Get CI green for guides migration (#1520)
Part of #1462

This PR prepares our checks for the guides migration to get green CI
when we make the change. Changes:

- Added API docs links to `ignore.ts`. Those links need to be updated
from the other repos and from the Box artifacts for historical versions.
Once the migration is done we'll have redirects set up for those links
as explained
[here](https://github.com/Qiskit/documentation/issues/1461).
- Added some words to the cspell dictionary and fixed other complaints
from the checker
- Added a script to fix the Qiskit bot files by changing the paths to
`guides/`. The PR also changes the ignores we had to `guides/`, leaving
the old ones that should be removed once the migration is done.
- Fixed the `update_internal_links.py` script to switch over more links
and consider the migration guides.
- Added entries for the notebooks with their names on the `guides/`
folder. Once the migration is done, we need to remove the old ones.
2024-06-14 17:07:03 +00:00
dependabot[bot] f68dc7ce27 Bump braces from 3.0.2 to 3.0.3 in the npm_and_yarn group across 1 directory (#1545)
Bumps the npm_and_yarn group with 1 update in the / directory:
[braces](https://github.com/micromatch/braces).

Updates `braces` from 3.0.2 to 3.0.3
<details>
<summary>Commits</summary>
<ul>
<li><a
href="74b2db2938"><code>74b2db2</code></a>
3.0.3</li>
<li><a
href="88f1429a0f"><code>88f1429</code></a>
update eslint. lint, fix unit tests.</li>
<li><a
href="415d660c30"><code>415d660</code></a>
Snyk js braces 6838727 (<a
href="https://redirect.github.com/micromatch/braces/issues/40">#40</a>)</li>
<li><a
href="190510f79d"><code>190510f</code></a>
fix tests, skip 1 test in test/braces.expand</li>
<li><a
href="716eb9f12d"><code>716eb9f</code></a>
readme bump</li>
<li><a
href="a5851e57f4"><code>a5851e5</code></a>
Merge pull request <a
href="https://redirect.github.com/micromatch/braces/issues/37">#37</a>
from coderaiser/fix/vulnerability</li>
<li><a
href="2092bd1fb1"><code>2092bd1</code></a>
feature: braces: add maxSymbols (<a
href="https://github.com/micromatch/braces/issues/">https://github.com/micromatch/braces/issues/</a>...</li>
<li><a
href="9f5b4cf473"><code>9f5b4cf</code></a>
fix: vulnerability (<a
href="https://security.snyk.io/vuln/SNYK-JS-BRACES-6838727">https://security.snyk.io/vuln/SNYK-JS-BRACES-6838727</a>)</li>
<li><a
href="98414f9f1f"><code>98414f9</code></a>
remove funding file</li>
<li><a
href="665ab5d561"><code>665ab5d</code></a>
update keepEscaping doc (<a
href="https://redirect.github.com/micromatch/braces/issues/27">#27</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/micromatch/braces/compare/3.0.2...3.0.3">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=braces&package-manager=npm_and_yarn&previous-version=3.0.2&new-version=3.0.3)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/Qiskit/documentation/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-06-14 09:50:45 +00:00
Frank Harkins 1981667525 Have cron job create PR to update notebook outputs (#1543)
Each time the fortnightly cron job runs, I usually make a PR updating
the notebooks in this repo with the output of the cron job. This PR
automates that process. As well as saving some manual work, this also
means I can review those PRs too.

See https://github.com/frankharkins/documentation/pull/10 for an example
of this working.
2024-06-13 17:38:54 +00:00
Rebecca Dimock 52552f42dc add information about changing tutorial title (#1544)
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
2024-06-13 16:39:47 +00:00