documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Evaluate if we should remove any historical Qiskit API docs post Qiskit 1.0?

Open Eric-Arellano opened this issue 6 months ago • 0 comments

Currently, we host in docs.quantum.ibm.com all the API docs for Qiskit that used to be in qiskit.org. Some of these docs are quite old, like Qiskit 0.19 from June 2020 (3.5 years old). It seems unlikely folks are still using this.

The main benefit of deleting old versions is to use fewer resources, such as speeding up CI in this repository because we don't need to run quality checks on those docs. Another benefit to users is less noise in the version selector because fewer options to choose.

But, we lose some history.

--

If we delete, we need to adjust our redirect strategy to avoid introducing 404s.

--

Update February 20, 2024: We discussed this in the dev meeting. Devs are not strongly against this, but also not super convinced it's worth removing. They challenged that we can simply choose to not run quality checks on old API docs.

They were more receptive to keeping the URLs up, but hiding them in the version selector. So have to manually change the URL or arrive at it from Google to access the version.

Either way, they're curious metrics on how many people visit the old docs.

Eric-Arellano avatar Feb 08 '24 16:02 Eric-Arellano