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.

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

Add historical release notes for Qiskit API #281

Closed
Eric-Arellano opened this issue Nov 3, 2023 · 2 comments · Fixed by #352
Closed

Add historical release notes for Qiskit API #281

Eric-Arellano opened this issue Nov 3, 2023 · 2 comments · Fixed by #352

Comments

@Eric-Arellano
Copy link
Collaborator

For Qiskit, it historically has a single release note file for everything: https://qiskit.org/documentation/release_notes.html. But we probably want to migrate to one file per version. It's way too big otherwise.

Where should the release note live in the UI?

Once we have a design, we need to:

  1. Port the original release note file from RST to MDX. This will take forever..I'm not sure how we want to pull it off. We may want to instead not include a ton of historical release notes? Point to the RST file?
  2. Figure out how Qiskit will do release notes in the future, if they keep using Reno. It's been working well for them and I suspect they'll want to keep using Reno. But how do we integrate that into MDX?
@frankharkins
Copy link
Member

@Eric-Arellano did we make any decisions on where it'll live in the UI?

@Eric-Arellano
Copy link
Collaborator Author

did we make any decisions on where it'll live in the UI?

Yes, it will be a simple top-level folder in the left sidebar. You'll replace this here in the _toc.json (by changing the generation script):

{
"title": "Changelog",
"url": "https://github.com/qiskit/qiskit/releases"
}
],

It should be a folder called "Release notes" and one page per minor release, e.g. "0.44".

Note that for Runtime and Provider, it instead will be a file called Release Notes, since they are so much smaller. #282

Eric-Arellano added a commit that referenced this issue Nov 10, 2023
We'll add back Qiskit 0.44 as part of
#281.

This PR switches us to the new version selector mechanism, per
#324.

We have to delete from the migration guide the link to 2 APIs. This will
be restored when we add the 0.44 historical API docs. Tracked by
#301.
@javabster javabster moved this to In Progress in Docs Planning Nov 13, 2023
frankharkins added a commit that referenced this issue Nov 17, 2023
Continuation of #346.

---

Closes #281, closes #354
@github-project-automation github-project-automation bot moved this from In Progress to Done in Docs Planning Nov 17, 2023
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
We'll add back Qiskit 0.44 as part of
Qiskit#281.

This PR switches us to the new version selector mechanism, per
Qiskit#324.

We have to delete from the migration guide the link to 2 APIs. This will
be restored when we add the 0.44 historical API docs. Tracked by
Qiskit#301.
frankharkins added a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants