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 "Latest updates" page #1411

Merged
merged 35 commits into from
Jun 24, 2024
Merged

Add "Latest updates" page #1411

merged 35 commits into from
Jun 24, 2024

Conversation

frankharkins
Copy link
Member

@frankharkins frankharkins commented May 20, 2024

Adds a latest updates page with some initial content. Closes #1301.

I've prioritised news that requires user action (i.e. deprecations), but open to other ideas too.

Points from a recent meeting:

  • We will want product owners to write a release summary for each release - and specify that the url out to the release notes should specify the version (this is mentioned in the Docs overview and publishing processes page)
  • Highlight product blogs, product announcements, and latest versions of each API ref release
  • Duplicate "what's new in the docs" from the announcements

@frankharkins
Copy link
Member Author

Also worth noting that we already have https://docs.quantum.ibm.com/announcements; maybe we should link out to that from the sidebar and more actively publish news there?

@javabster
Copy link
Collaborator

thanks Frank!

I see all these latest updates are hardcoded into the page, can you think of any ways to make this more automated? I like the idea of summarising some of the biggest things that have happened recently with code examples but I think its going to be difficult to maintain. If we cant think of a more automated way to generate this page then I think we should stick with the type of thing you did in the first paragraph - just listing out links of where people can find latest updates.

Some extra things we could link out to:

Also I think it would be good to split sections out by package - so have a section at the top which is for general updates (e.g. link to product announcements, qiskit blog etc.) then a section of Qiskit SDK (link to release notes and latest release blog), then runtime, then transpiler service, then maybe a community section (with the events link?)

@frankharkins
Copy link
Member Author

Closing as we've decided to link out to the announcements page instead.

@frankharkins frankharkins deleted the FH/latest-updates branch June 10, 2024 15:00
@abbycross abbycross restored the FH/latest-updates branch June 12, 2024 18:02
@abbycross abbycross reopened this Jun 12, 2024
@abbycross
Copy link
Collaborator

Reopening!

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
@javabster
Copy link
Collaborator

Screenshot 2024-06-21 at 8 58 49 AM

somethings gone wrong with the italics here?

@javabster
Copy link
Collaborator

other than the italics issue this LGTM!

Copy link
Collaborator

@jyu00 jyu00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments but otherwise LGTM.

One suggestion though - what do you think about putting a last updated at the top of the page? So people know if something has changed since their last visit.

docs/start/latest-updates.mdx Outdated Show resolved Hide resolved
docs/start/latest-updates.mdx Outdated Show resolved Hide resolved
docs/start/latest-updates.mdx Outdated Show resolved Hide resolved
@abbycross abbycross added this pull request to the merge queue Jun 24, 2024
Merged via the queue into main with commit 6123ca7 Jun 24, 2024
3 checks passed
@abbycross abbycross deleted the FH/latest-updates branch June 24, 2024 17:10
frankharkins added a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Adds a latest updates page with some initial content. Closes Qiskit#1301.

I've prioritised news that requires user action (i.e. deprecations), but
open to other ideas too.

Points from a recent meeting:
- We will want product owners to write a release summary for each
release - and specify that the url out to the release notes should
specify the version (this is mentioned in the Docs overview and
publishing processes page)
- Highlight product blogs, product announcements, and latest versions of
each API ref release
- Duplicate "what's new in the docs" from the announcements

---------

Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Co-authored-by: ABBY CROSS <across@us.ibm.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content request request for new content to be added content 📄
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[ NEW PAGE ] Latest updates for "get started" section of guides tab
6 participants