Qiskit / Qiskit/documentation

Dates for versions on release notes page?

Open
#2,246 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content 📄 infra 🏗️
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL, if applicable

https://docs.quantum.ibm.com/api/qiskit/release-notes

https://docs.quantum.ibm.com/api/qiskit/release-notes/1.2

maybe also (not sure if this is the right repo): https://qiskit.github.io/qiskit-aer/release_notes.html
etc

Describe the new content you are requesting.

Can we add version release dates on the release-notes pages?

At one time, the qiskit release notes included a table listing the versions and the release date for each.

As a user, I found the dates very helpful in quickly knowing whether or not I have the latest release (without having to check the version installed on my system), and also to quickly learn about whether code I've run in the recent past could have e.g. been run before or after relevant bug-fixes in qiskit (since if I ran it a month ago and I see that a relevant bug-fix came out last week, then I immediately know I should try updating qiskit and re-running the code).

If this new content request is accepted, do you want to write the content?

no

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Qiskit release-notes pages at the URLs in the issue and look for the earlier version-and-date table mentioned there. Check whether the request applies to the main Qiskit pages and the linked Qiskit Aer page; it is done when the relevant release-notes pages show release dates for their versions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.