Release Notes Overhaul #3539
Labels
Documentation
Epic
Status: Untriaged
An issue that has yet to be triaged.
Type: Docs Intake
Medium and Large Docs Support Requests
General details
People are looking for three features:
Review
Name of technical reviewer: Me
Searchable Release Notes
Original Issue: #3519
The big issue here is that there is currently no way to get Hugo to pull in MD files from packages.chef.io and deploy them as a static page and Swiftype can't index text that's not static.
Options:
getResource
function in Hugo which could grab MD files. Wait for them to finish which could be many months or years.The downside of using Hugo's getJSON function is that it will add a considerable amount of time to the build process. I could set it so that Hugo only builds the release notes on a production deploy.
Single Page Release Notes
Original Issue: #3273
This could be done in JavaScript. We could have one page for all release notes for a product and then another page with the existing style that lists a single page of release notes.
Product release dates
Original Issue: #3510
As far as I know there's no list or file of release note dates for products. It seems like there should be one somewhere though. The Automate release notes gets the release date by parsing the name of each MD file.
The text was updated successfully, but these errors were encountered: