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

Automatically generate "what's new" section for the docs landing page for new releases #3151

Open
natalie-bernhard opened this issue Apr 24, 2023 · 4 comments
Labels
enhancement Improvements to existing functionality; redesigns needs discussion Need clarification on deliverables

Comments

@natalie-bernhard
Copy link
Contributor

natalie-bernhard commented Apr 24, 2023

Idea originated in Slack thread

From @dmuelle : "Having some what's new content on the overview page would make better use of the space than what we've got currently. In WL we have the What is new in this release of Liberty page that we update for each release. We could do something similar on the overview page, maybe just the section headings and a brief description, linking out to release post for more. Not many people go to the Overview page on purpose but it is what you get when you click Docs from the homepage. I can mock something up if youre interested"

From @mbroz2 : "I wonder if we could automatically generate a 'what's new' section in docs overview that would include a link to the corresponding blog post, as well as links to new doc pages or new sections in existing pages......."
"would probably have to happen in a github action that creates a PR (similar to release/beta blog post creation), rather then at build time, since the latter would be too risky for something so visible" (this is similar to how we handle certs)

@natalie-bernhard natalie-bernhard converted this from a draft issue Apr 24, 2023
@natalie-bernhard natalie-bernhard added the enhancement Improvements to existing functionality; redesigns label Apr 24, 2023
@natalie-bernhard
Copy link
Contributor Author

TO DO: Check analytics to see docs landing page traffic; this will help to determine the priority of the issue

@mbroz
Copy link

mbroz commented Apr 24, 2023

Please subscribe the correct @mbroz2 not me :)

@steven1046 steven1046 moved this from New (Untriaged) to In Design/Discussion in Website backlog Apr 26, 2023
@steven1046 steven1046 added the needs discussion Need clarification on deliverables label Apr 26, 2023
@natalie-bernhard
Copy link
Contributor Author

natalie-bernhard commented May 4, 2023

Notes from 5/4 Site Meeting

  • This page does not have significant content, so interaction analytics will likely be low, this should not determine the priority of the issue
  • Include headlines from the release blog and one to two sentences explaining the feature (possibly automate pulling these headlines)
  • Point users from release blog to Docs “what’s new?” with link (this could be added to release blog template)
  • Each version has a “What’s new” for that specific version; include version in “What’s New” section title to reinforce this to the user (ex. "What's new in 23.0.0.4?")

@steven1046
Copy link
Member

This will require research into how we want to automate pulling in the content from the release blog, or where the blog gets its content.

@steven1046 steven1046 moved this from In Design/Discussion to Backlog (Ready to Start) in Website backlog May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements to existing functionality; redesigns needs discussion Need clarification on deliverables
Projects
Status: Backlog (Ready to Start)
Development

No branches or pull requests

3 participants