documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Don't link to announcements

Open Eric-Arellano opened this issue 8 months ago β€’ 1 comments

This will break on the cloud app because announcements don't exist there:

https://github.com/Qiskit/documentation/blob/cdd1f470d7439aa4931b7e4665a85491d4f7844a/docs/guides/transpile-rest-api.mdx?plain=1#L21

Instead, we should use an absolute link. Long-term, we need to figure out what to link to because announcements won't live in the Docs platform.

To fix, remove this line, then run npm run check:internal-links:

https://github.com/Qiskit/documentation/blob/cdd1f470d7439aa4931b7e4665a85491d4f7844a/scripts/js/lib/links/ignores.ts#L139

Eric-Arellano avatar Apr 22 '25 12:04 Eric-Arellano

https://github.com/Qiskit/documentation/pull/3028 fixed the actual bug, but we should still not link to announcements long term because it's not safe when the Legacy app goes away. The content team will need to please figure out how to adjust this content:

Image

Or, plan on changing the link in he future to the new announcements home.

Eric-Arellano avatar Apr 22 '25 14:04 Eric-Arellano

The Cloud app has announcements now, so it's safe to link to them again. We should avoid using any absolute/external link as we want the users to stay on the same platform they are.

https://github.com/Qiskit/documentation/pull/3348 updates the links to make them relative.

arnaucasau avatar Jun 17 '25 10:06 arnaucasau