Follow up to https://github.com/Qiskit/documentation/pull/1917. That
resulted in some pages having their behavior fixed, so we can be more
strict in our API lints.
This PR also makes some bigger improvements to the checks:
* Runs `check:metadata` in CI, thanks to a new allowlist
* Simplifies `check:orphan-pages` to have an `--apis` arg
* DRYs our ignore list for `check:internal-links`
Add the latest blog entry as well as "What's new in the docs" from
July/August.
---------
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Closes https://github.com/Qiskit/documentation/issues/1401 and
https://github.com/Qiskit/documentation/issues/935.
We reuse `<Attribute>`, which actually works out quite well! It
understands how to parse when the data object has a value assigned to it
like `= "my_value"`. It can also properly detect `isDedicatedPage`.
There is one weird edge case: Qiskit was improperly using `.. py:data::`
inside a table in `utils.mdx`. Naively, it would cause issues with
trying to render the component inside the table, which does not work. I
fixed it in Qiskit `main`, but it would be too time consuming to fix on
0.35+. So, we now have a line to skip over converting to an `Attribute`
Component if the element is inside a table. That means the table will
continue to render the same as before on those historical docs - the
biggest downside is that anchor links still will be broken for the page.
<img width="863" alt="Screenshot 2024-09-06 at 9 40 51 AM"
src="https://github.com/user-attachments/assets/f7355c1f-ed50-4293-976d-42f02fdf6013">
A follow up will simplify our linters like checking for orphan pages,
since this PR fixes a lot of those problems.
We have some attribute pages that are aliases, like `Sampler` being an
alias for `SamplerV1`. These pages weren't showing up in the ToC
(orphans) because of an oversight.
This PR also makes these improvements:
* Fixes our code for copying release note images to the correct location
for Qiskit, as a continuation of
https://github.com/Qiskit/documentation/pull/1914
* Uses `ApiType` rather than `string` in more places so that we get
stronger typing
* Removes an unused arg, `$main`
https://github.com/Qiskit/documentation/pull/1848 only fixed `npm run
make-historical`, but not `npm run gen-api` and `npm run regen-apis`.
With this PR, 1.1 stays the same when regenerating, whereas before the
release note changed.
I also manually changed the Sphinx artifact for 1.0 to fix a link to a
page we migrated.
There were some changes that we didn't properly set up by regenerating
the API docs. This runs `npm run regen-apis`.
The file docs/api/qiskit-ibm-runtime/0.23/options.mdx was manually
changed in the uploaded Box artifact to avoid a regression where the
link changed to point to current API docs for a page that was deleted.
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.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
All the pages were renamed in 0.5, so we'll set up redirects in closed
source.
We also set up precise redirects in `historical-pages-to-latest.json`.
Otherwise, those pages would have gone to `/` (root).
Updates the requirements on
[qiskit-serverless](https://github.com/Qiskit/qiskit-serverless) to
permit the latest version.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/Qiskit/qiskit-serverless/releases">qiskit-serverless's
releases</a>.</em></p>
<blockquote>
<h2>v0.16.1</h2>
<h2>Changes</h2>
<ul>
<li>update-version-0.16.1 <a
href="https://github.com/github-actions"><code>@github-actions</code></a>
(<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1476">#1476</a>)</li>
<li>Include function data folder in docker image <a
href="https://github.com/Tansito"><code>@Tansito</code></a> (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1475">#1475</a>)</li>
<li>Fix serve static files and logger info <a
href="https://github.com/Tansito"><code>@Tansito</code></a> (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1474">#1474</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="5fa7ee9166"><code>5fa7ee9</code></a>
update-version-0.16.1 (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1476">#1476</a>)</li>
<li><a
href="524624a032"><code>524624a</code></a>
Include function data folder in docker image (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1475">#1475</a>)</li>
<li><a
href="cdcff5efbe"><code>cdcff5e</code></a>
Fix serve static files (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1474">#1474</a>)</li>
<li><a
href="877bce74a6"><code>877bce7</code></a>
update-version-0.16.0 (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1469">#1469</a>)</li>
<li><a
href="81cc293a80"><code>81cc293</code></a>
Remove tasks (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1468">#1468</a>)</li>
<li><a
href="16bbfcdb17"><code>16bbfcd</code></a>
Make job.list go through query parameters (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1467">#1467</a>)</li>
<li><a
href="48ac9dd2da"><code>48ac9dd</code></a>
add filters to /job and /program (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1466">#1466</a>)</li>
<li><a
href="0e14adf891"><code>0e14adf</code></a>
Admin panel (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1464">#1464</a>)</li>
<li><a
href="4b088ae930"><code>4b088ae</code></a>
Catalog end-points (<a
href="https://redirect.github.com/Qiskit/qiskit-serverless/issues/1460">#1460</a>)</li>
<li>See full diff in <a
href="https://github.com/Qiskit/qiskit-serverless/compare/v0.15.2...v0.16.1">compare
view</a></li>
</ul>
</details>
<br />
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 this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
</details>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
Bumps the npm_and_yarn group with 1 update in the / directory:
[micromatch](https://github.com/micromatch/micromatch).
Updates `micromatch` from 4.0.7 to 4.0.8
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/micromatch/micromatch/releases">micromatch's
releases</a>.</em></p>
<blockquote>
<h2>4.0.8</h2>
<p>Ultimate release that fixes both CVE-2024-4067 and CVE-2024-4068. We
consider the issues low-priority, so even if you see automated scanners
saying otherwise, don't be scared.</p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/micromatch/micromatch/blob/master/CHANGELOG.md">micromatch's
changelog</a>.</em></p>
<blockquote>
<h2>[4.0.8] - 2024-08-22</h2>
<ul>
<li>backported CVE-2024-4067 fix (from v4.0.6) over to 4.x branch</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="8bd704ec0d"><code>8bd704e</code></a>
4.0.8</li>
<li><a
href="a0e68416a4"><code>a0e6841</code></a>
run verb to generate README documentation</li>
<li><a
href="4ec288484f"><code>4ec2884</code></a>
Merge branch 'v4' into hauserkristof-feature/v4.0.8</li>
<li><a
href="03aa805217"><code>03aa805</code></a>
Merge pull request <a
href="https://redirect.github.com/micromatch/micromatch/issues/266">#266</a>
from hauserkristof/feature/v4.0.8</li>
<li><a
href="814f5f70ef"><code>814f5f7</code></a>
lint</li>
<li><a
href="67fcce6a10"><code>67fcce6</code></a>
fix: CHANGELOG about braces & CVE-2024-4068, v4.0.5</li>
<li><a
href="113f2e3fa7"><code>113f2e3</code></a>
fix: CVE numbers in CHANGELOG</li>
<li><a
href="d9dbd9a266"><code>d9dbd9a</code></a>
feat: updated CHANGELOG</li>
<li><a
href="2ab13157f4"><code>2ab1315</code></a>
fix: use actions/setup-node@v4</li>
<li><a
href="1406ea38f3"><code>1406ea3</code></a>
feat: rework test to work on macos with node 10,12 and 14</li>
<li>Additional commits viewable in <a
href="https://github.com/micromatch/micromatch/compare/4.0.7...4.0.8">compare
view</a></li>
</ul>
</details>
<br />
[](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>
Part of https://github.com/Qiskit/documentation/issues/1870. We'll set
up redirects in closed source from `qiskit-transpiler-service/*` to
`qiskit-ibm-transpiler/*`.
We don't yet generate `qiskit-ibm-transpiler` version 0.5 because that
is going to require a new set of more specific redirects, as the page
names will change from `qiskit_transpiler_service.Foo` to
`qiskit_ibm_transpiler.Foo`. That'll be done in a follow up after this
initial migration is complete.
We were being inconsistent with calling Runtime "Qiskit Runtime IBM
Client" but "Qiskit IBM Runtime REST API". We also don't use IBM with
"Qiskit Transpiler Service Client" and "Qiskit SDK". So, `@jyu00` and
`@javabster` proposed that we simplify to remove the redundant IBM.
This PR updates the left page titles we use. A closed source PR will
update the top dropdown.
We don't update the index pages for Runtime API docs because those are
auto-generated.
Suggestion to make the sentence clearer - use this, from Marco:
> The scheduler's default behavior is to select the next job by first
identifying the group that has used the least amount of their allocation
within the current scheduling window. If the selected group has more
than one project, and both have jobs waiting to be executed, then the
scheduler identifies the project that has used the least of their
allocation within the scheduling window. Finally, if the selected
project has submitted more than one job, the scheduler will select the
oldest job first.
Also adds appropriate trademark to a recent appearance of "IBM" on the
page
Rebecca Dimock