Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Indicate IBM Provider is deprecated in left navbar #1197

Merged
merged 7 commits into from
Apr 18, 2024
Merged

Indicate IBM Provider is deprecated in left navbar #1197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4c8ff82
Indicate IBM Provider is deprecated in left navbar
Eric-Arellano Apr 18, 2024
aa92d21
Regenerate qiskit-ibm-provider 0.10.0
Eric-Arellano Apr 18, 2024
b20acbb
Regenerate qiskit-ibm-provider 0.7.3
Eric-Arellano Apr 18, 2024
bd18554
Regenerate qiskit-ibm-provider 0.8.0
Eric-Arellano Apr 18, 2024
e797763
Regenerate qiskit-ibm-provider 0.9.0
Eric-Arellano Apr 18, 2024
7050495
Regenerate qiskit-ibm-provider 0.11.0
Eric-Arellano Apr 18, 2024
5e3e8a4
Change how we do release notes page title
Eric-Arellano Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/api/qiskit-ibm-provider/0.10/_toc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Qiskit IBM Provider",
"title": "Qiskit IBM Provider (deprecated)",
"children": [
{
"title": "qiskit_ibm_provider",
Expand Down Expand Up @@ -211,4 +211,3 @@
],
"collapsed": true
}

2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/_toc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Qiskit IBM Provider",
"title": "Qiskit IBM Provider (deprecated)",
"children": [
{
"title": "qiskit_ibm_provider",
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/_toc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Qiskit IBM Provider",
"title": "Qiskit IBM Provider (deprecated)",
"children": [
{
"title": "qiskit_ibm_provider",
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/_toc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Qiskit IBM Provider",
"title": "Qiskit IBM Provider (deprecated)",
"children": [
{
"title": "qiskit_ibm_provider",
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/_toc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Qiskit IBM Provider",
"title": "Qiskit IBM Provider (deprecated)",
"children": [
{
"title": "qiskit_ibm_provider",
Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit-ibm-provider/release-notes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Qiskit IBM Provider release notes
description: Changes made to Qiskit IBM Provider
title: Qiskit IBM Provider (deprecated) release notes
description: Changes made to Qiskit IBM Provider (deprecated)
in_page_toc_max_heading_level: 2
---

<span id="release-notes" />

# Qiskit IBM Provider 0.11 release notes
# Qiskit IBM Provider (deprecated) release notes

<span id="release-notes-0-11-0" />

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/release-notes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ in_page_toc_max_heading_level: 2

<span id="qiskit-runtime-ibm-client-release-notes" />

# Qiskit Runtime IBM Client 0.23 release notes
# Qiskit Runtime IBM Client release notes

<span id="id1" />

Expand Down
9 changes: 8 additions & 1 deletion scripts/lib/api/Pkg.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export class Pkg {
if (name === "qiskit-ibm-provider") {
return new Pkg({
...args,
title: "Qiskit IBM Provider",
title: "Qiskit IBM Provider (deprecated)",
name: "qiskit-ibm-provider",
githubSlug: "qiskit/qiskit-ibm-provider",
hasSeparateReleaseNotes: false,
Expand Down Expand Up @@ -162,6 +162,13 @@ export class Pkg {
return this.name !== "qiskit" || +this.versionWithoutPatch >= 0.45;
}

releaseNotesTitle(): string {
const versionStr = this.hasSeparateReleaseNotes
? ` ${this.versionWithoutPatch}`
: "";
return `${this.title}${versionStr} release notes`;
}

/**
* Returns a function that takes in a fileName like `qiskit_ibm_provider/job/exceptions` and returns the
* stable GitHub URL to the file for this package's version.
Expand Down
2 changes: 1 addition & 1 deletion scripts/lib/api/conversionPipeline.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ async function convertFilesToMarkdown(
fileName: file,
determineGithubUrl: pkg.determineGithubUrlFn(),
imageDestination: pkg.outputDir("/images"),
releaseNotesTitle: `${pkg.title} ${pkg.versionWithoutPatch} release notes`,
releaseNotesTitle: pkg.releaseNotesTitle(),
});

// Avoid creating an empty markdown file for HTML files without content
Expand Down
Loading